Optimizely

Optimizely Click profiles API

Manage click profiles

GitHub OpenAPI

Operations 7

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 /{clientId}/clickprofiles List click profiles · Get information about all click profiles #
Ask an LLM
“Which click profiles exist for categorizing link clicks in Optimizely Campaign?”
“Can I limit the click profiles returned to ones in a particular folder?”
Tell an agent
List click profiles for client {clientId}.
Show up to {limit} click profiles in folder {folderId} for client {clientId}.
POST /{clientId}/clickprofiles Create a click profile · Create a new click profile #
Ask an LLM
“How do I set up a new click profile to tag links in my mailings?”
“Can a new click profile match links by a rule pattern?”
Tell an agent
Create click profile {name} for client {clientId}.
Create click profile {name} for client {clientId} with rule type {ruleType} and pattern {rulePattern}.
POST /{clientId}/clickprofiles/{clickProfileId}/assignedlinks Assign links to a click profile · Assign links to a click profile #
Ask an LLM
“How do I attach specific links to a click profile?”
“Can I assign several links to one click profile at once?”
Tell an agent
Assign links {linkIds} to click profile {clickProfileId} for client {clientId}.
Attach link ids {linkIds} to click profile {clickProfileId} in client {clientId}.
DELETE /{clientId}/clickprofiles/{clickProfileId}/assignedlinks Unassign links from a click profile · Unassign specific links from a click profile #
Ask an LLM
“How can I detach links from a click profile without deleting the profile?”
“Is it possible to remove only some of a click profile's links?”
Tell an agent destructive · confirm first
Unassign links {linkIds} from click profile {clickProfileId} for client {clientId}.
Detach link ids {linkIds} from click profile {clickProfileId} in client {clientId}.
GET /{clientId}/clickprofiles/{clickProfileId} Get one click profile's details · Get information about a click profile #
Ask an LLM
“What name, description and rule pattern does a specific click profile have?”
“Can I look up a single click profile by its id?”
Tell an agent
Get click profile {clickProfileId} for client {clientId}.
Show the rule details of click profile {clickProfileId} in client {clientId}.
POST /{clientId}/clickprofiles/{clickProfileId} Update a click profile · Update a click profile #
Ask an LLM
“Can I rename an existing click profile or change its description?”
“Is it possible to change the rule pattern on a click profile I already made?”
Tell an agent
Rename click profile {clickProfileId} in client {clientId} to {name}.
Update click profile {clickProfileId} for client {clientId}: name {name}, description {description}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-click-profiles-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-click-profiles-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-click-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Click profiles API
  description: This documentation lists all available resources and endpoints of the Optimizely Campaign REST API.
  version: '1'
servers:
- url: https://api.campaign.episerver.net/rest
tags:
- name: Click profiles
  description: Manage click profiles
paths:
  /{clientId}/clickprofiles:
    get:
      tags:
      - Click profiles
      summary: Get information about all click profiles
      description: Get detailed information about all click profiles, such as name, description, rule or rule type. You can filter for profiles in a folder or limit the number of retrieved click profiles.
      operationId: selectClickProfiles
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: 'Starting point of the result list <p><i>Default value</i> : 0</p>'
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Maximum number of retrieved click profiles <p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: Sort result by specific criteria
        schema:
          type: string
          default: created
          enum:
          - created
          - modified
          - name
          - description
          - rulePattern
          - ruleType
      - name: folderId
        in: query
        description: Filter click profiles assigned to a folder
        schema:
          type: integer
          format: int64
      - name: clickProfileIds
        in: query
        description: Filter click profiles by IDs
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: direction
        in: query
        description: Sort order
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: linkIds
        in: query
        description: Filter click profiles assigned to the link IDs
        schema:
          type: array
          items:
            type: integer
            format: int64
      responses:
        '200':
          description: The click profiles were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestClickProfileStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestClickProfileStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Click profiles
      summary: Create a new click profile
      description: Create a new click profile. You can specify the name, the description, the rule pattern, the rule type of the new click profile.
      operationId: createClickProfile
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClickProfileRequestData'
      responses:
        '201':
          description: The click profile was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
        '400':
          description: The request parameters are invalid.
      security:
      - Authorization: []
  /{clientId}/clickprofiles/{clickProfileId}/assignedlinks:
    get:
      tags:
      - Click profiles
      summary: Get links a click profile is assigned to
      description: Get the links to which a specified click profile is assigned.
      operationId: getAssignedLinks
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: 'Starting point of the result list <p><i>Default value</i> : 0</p>'
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Maximum number of retrieved links <p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: urlPattern
        in: query
        description: Filter links matching given pattern
        schema:
          type: string
      - name: urls
        in: query
        description: Filter links by their urls
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: mailingIds
        in: query
        description: Filter links associated with given mailing IDs
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: searchTerm
        in: query
        description: Value of the column to be searched. It is used in conjunction with 'searchColumn'.
        schema:
          type: string
      - name: searchColumn
        in: query
        description: Name of the column to be searched. It is used in conjunction with 'searchTerm'.
        schema:
          type: string
          enum:
          - id
          - name
          - type
          - url
          - created
          - modified
      - name: sort
        in: query
        description: Sort result by specific criteria
        schema:
          type: string
          default: created
          enum:
          - id
          - name
          - type
          - url
          - created
          - modified
      - name: name
        in: query
        description: Filter links by their name
        schema:
          type: string
      - name: types
        in: query
        description: Filter links by their types
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: direction
        in: query
        description: Sort order
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: clickProfileId
        in: path
        description: Click profile ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The assigned links were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestLinkStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestLinkStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Click profiles
      summary: Assign links to a click profile
      description: Assign specific links to a click profile.
      operationId: assignLinksToClickProfile
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: clickProfileId
        in: path
        description: Click profile ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AssignLinksToClickProfileRequestData'
      responses:
        '200':
          description: The links were assigned successfully to a click profile.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestLink'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestLink'
      security:
      - Authorization: []
    delete:
      tags:
      - Click profiles
      summary: Unassign specific links from a click profile
      operationId: unAssignLinksFromClickProfile
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: linkIds
        in: query
        description: Comma-separated list of link IDs
        required: true
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: clickProfileId
        in: path
        description: Click profile ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: The links were unassigned from the click profile successfully.
      security:
      - Authorization: []
  /{clientId}/clickprofiles/{clickProfileId}:
    get:
      tags:
      - Click profiles
      summary: Get information about a click profile
      description: Get detailed information about a click profile, such as name, description, rule pattern or rule type.
      operationId: getClickProfile
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: clickProfileId
        in: path
        description: Click profile ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The click profile was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
        '404':
          description: The click profile could not be found. Ensure that the required parameters such as "clickProfileId" are correct and the click profile exists.
        '409':
          description: The click profile is not assigned to the client. Ensure that the required parameters such as "clientId" and "clickProfileId" are correct and the folder exists.
      security:
      - Authorization: []
    post:
      tags:
      - Click profiles
      summary: Update a click profile
      description: Update information of a click profile, such as name or description.
      operationId: updateClickProfile
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: clickProfileId
        in: path
        description: Click profile ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClickProfileRequestData'
      responses:
        '200':
          description: The click profile was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestClickProfile'
        '400':
          description: The request parameters are invalid.
        '404':
          description: The click profile could not be found. Ensure that the required parameters such as "clickProfileId" are correct and the click profile exists.
        '409':
          description: The click profile is not assigned to the client. Ensure that the required parameters such as "clientId" and "clickProfileId" are correct and the folder exists.
      security:
      - Authorization: []
components:
  schemas:
    RestLinkStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestLink'
        links:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/RestApiLink'
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    RestApiLink:
      type: object
      properties:
        href:
          type: string
        rel:
          type: string
    RestClickProfileStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestClickProfile'
        links:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/RestApiLink'
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    RestLink:
      type: object
      properties:
        id:
          type: integer
          description: Link ID
          format: int64
        name:
          type: string
          description: Link name
        url:
          type: string
          description: Link URL
        type:
          type: string
          description: Link type
        created:
          type: string
          description: Creation date
          format: date-time
        modified:
          type: string
          description: Modification date
          format: date-time
    AssignLinksToClickProfileRequestData:
      required:
      - linkIds
      type: object
      properties:
        linkIds:
          type: array
          description: Comma-separated list of link IDs
          items:
            type: integer
            description: Comma-separated list of link IDs
            format: int64
    ClickProfileRequestData:
      required:
      - name
      type: object
      properties:
        rulePattern:
          type: string
          description: Rule pattern of the click profile
        name:
          type: string
          description: Name of the click profile
        description:
          type: string
          description: Description of the click profile
        ruleType:
          type: string
          description: Rule type of the click profile
          default: NONE
          enum:
          - REGEXP
          - WILDCARDS
          - NONE
    RestClickProfile:
      type: object
      properties:
        id:
          type: integer
          description: Click profile ID
          format: int64
        name:
          type: string
          description: Click profile name
        description:
          type: string
          description: Click profile description
        rulePattern:
          type: string
          description: Click profile rule pattern
        ruleType:
          type: string
          description: Click profile rule type
        created:
          type: string
          description: Creation date
          format: date-time
        modified:
          type: string
          description: Modification date
          format: date-time
        links:
          type: array
          description: Restful links
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
            description: Restful links
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true