Optimizely Search Term Redirects API

The Search Term Redirects API from Optimizely — 7 operation(s) for search term redirects.

Operations 11

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/v1/admin/SearchTermRedirects List search term redirects · Returns the EntitySet SearchTermRedirects #
Ask an LLM
“Which search terms currently redirect shoppers to another page?”
“Can I filter search term redirects by the term itself?”
Tell an agent
List all search term redirects.
Show search term redirects matching {filter}.
POST /api/v1/admin/SearchTermRedirects Redirect a search term to a page · Post a new entity to EntitySet SearchTermRedirects #
Ask an LLM
“How do I send shoppers who search a certain word straight to a specific page?”
“Can a search redirect be scheduled to start and stop on set dates?”
Tell an agent
Redirect searches for {term} to {redirectUri}.
Create a redirect for search term {term} to {redirectUri} starting {activateOn}.
GET /api/v1/admin/SearchTermRedirects({id}) Get one search term redirect · Returns the entity with the key from SearchTermRedirects #
Ask an LLM
“How do I look up a single search redirect by id?”
“Where does a specific search term redirect point?”
Tell an agent
Fetch search term redirect {id}.
Show the target URL of search redirect {id}.
PUT /api/v1/admin/SearchTermRedirects({id}) Replace a search term redirect · Replace entity in EntitySet SearchTermRedirects #
Ask an LLM
“Can I fully replace an existing search redirect's term and target?”
“Does replacing a search redirect reset its activation dates?”
Tell an agent
Replace redirect {id} so {term} goes to {redirectUri}.
Overwrite the whole search redirect record {id}.
DELETE /api/v1/admin/SearchTermRedirects({id}) Delete a single search term redirect · Delete entity in EntitySet SearchTermRedirects #
Ask an LLM
“How do I stop one search term from redirecting?”
“Can I delete a search redirect only if nobody else changed it?”
Tell an agent destructive · confirm first
Delete search term redirect {id}.
Remove search redirect {id} if its ETag is {etag}.
PATCH /api/v1/admin/SearchTermRedirects({id}) Change where a search term redirects · Update entity in EntitySet SearchTermRedirects #
Ask an LLM
“Can I point an existing search redirect at a new URL?”
“Is there a way to set an end date on a search redirect I already made?”
Tell an agent
Point search redirect {id} to {redirectUri}.
Deactivate search redirect {id} on {deactivateOn}.
GET /api/v1/admin/SearchTermRedirects/Default.Default() Get default values for a new search redirect · Call operation Default #
Ask an LLM
“What defaults does a new search term redirect start with?”
“Is there a blank search redirect template?”
Tell an agent
Get the default values for a new search term redirect.
Show the empty search redirect record.
POST /api/v1/admin/SearchTermRedirects/Default.archive Archive search redirects via the OData action · Call operation archive #
Ask an LLM
“How do I archive search redirects with the OData Default.archive action?”
“Can I retire old search redirects using the archive action call?”
Tell an agent destructive · confirm first
Run the OData archive action on search redirects {ids}.
Archive search term redirects {ids} with Default.archive.
DELETE /api/v1/admin/searchtermredirects/archive Archive search redirects through the archive route · Search term redirects archive route #
Ask an LLM
“Is there a REST route to archive a batch of search redirects?”
“What does a DELETE on searchtermredirects/archive do?”
Tell an agent destructive · confirm first
Archive search redirects {ids} via the searchtermredirects/archive route.
Send the batch archive request for search redirects {ids}.
DELETE /api/v1/admin/searchtermredirects/delete Permanently delete several search redirects · Search term redirects delete route #
Ask an LLM
“How do I bulk delete search term redirects?”
“Can I permanently remove a list of search redirects at once?”
Tell an agent destructive · confirm first
Bulk delete search term redirects {ids}.
Permanently delete every search redirect in {ids}.
GET /api/v1/admin/searchtermredirects({key})/customproperties({custompropertyKey}) Get a custom property on a search redirect · Search term redirects get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a search term redirect?”
“Can I fetch one custom field from a search redirect?”
Tell an agent
Get custom property {custompropertyKey} of search redirect {key}.
Show the {custompropertyKey} custom property on search term redirect {key}.

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-search-term-redirects-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.

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

OpenAPI Specification

optimizely-search-term-redirects-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Search Term Redirects API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Search Term Redirects
paths:
  /api/v1/admin/SearchTermRedirects:
    get:
      tags:
      - Search Term Redirects
      summary: Returns the EntitySet SearchTermRedirects
      operationId: SearchTermRedirects_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Search Term Redirects
      summary: Post a new entity to EntitySet SearchTermRedirects
      operationId: SearchTermRedirects_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SearchTermRedirect'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SearchTermRedirects({id}):
    get:
      tags:
      - Search Term Redirects
      summary: Returns the entity with the key from SearchTermRedirects
      operationId: SearchTermRedirects_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Search Term Redirects
      summary: Replace entity in EntitySet SearchTermRedirects
      operationId: SearchTermRedirects_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SearchTermRedirect'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Search Term Redirects
      summary: Delete entity in EntitySet SearchTermRedirects
      operationId: SearchTermRedirects_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Search Term Redirects
      summary: Update entity in EntitySet SearchTermRedirects
      operationId: SearchTermRedirects_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SearchTermRedirect'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SearchTermRedirects/Default.Default():
    get:
      tags:
      - Search Term Redirects
      summary: Call operation Default
      operationId: SearchTermRedirects_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SearchTermRedirects/Default.archive:
    post:
      tags:
      - Search Term Redirects
      summary: Call operation archive
      operationId: SearchTermRedirects_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/searchtermredirects/archive:
    delete:
      tags:
      - Search Term Redirects
      operationId: SearchTermRedirects_ArchiveRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Search term redirects archive route
      x-summary-source: derived
  /api/v1/admin/searchtermredirects/delete:
    delete:
      tags:
      - Search Term Redirects
      operationId: SearchTermRedirects_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Search term redirects delete route
      x-summary-source: derived
  /api/v1/admin/searchtermredirects({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Search Term Redirects
      operationId: SearchTermRedirects_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Search term redirects get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.SearchTermRedirect:
      required:
      - term
      - redirectUri
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        term:
          type: string
        redirectUri:
          type: string
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        activateOn:
          format: date-time
          type: string
        deactivateOn:
          format: date-time
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query