Optimizely

Optimizely Message Audits API

The Message Audits API from Optimizely — 5 operation(s) for message audits.

GitHub OpenAPI

Operations 9

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/MessageAudits List message audit entries · Returns the EntitySet MessageAudits #
Ask an LLM
“How do I review the audit trail of messages sent between users?”
“Where can I see all message audit records?”
Tell an agent
List all message audit entries.
Show me the full message audit log.
POST /api/v1/admin/MessageAudits Record a message audit entry · Post a new entity to EntitySet MessageAudits #
Ask an LLM
“How do I log a message audit entry for an order?”
“What does a message audit record need, such as process and body?”
Tell an agent
Record a message audit for process {process} with body {body}.
Log an audit of message {messageId} on order {customerOrderId}, process {process}.
GET /api/v1/admin/MessageAudits({id}) Get one message audit entry · Returns the entity with the key from MessageAudits #
Ask an LLM
“Is there a call to read a single message audit record?”
“Who sent and received the message in a specific audit entry?”
Tell an agent
Get message audit {id}.
Show sender and recipient on audit entry {id}.
PUT /api/v1/admin/MessageAudits({id}) Replace a message audit entry · Replace entity in EntitySet MessageAudits #
Ask an LLM
“What's the call to overwrite a message audit record entirely?”
“Which fields must I resend when replacing an audit entry?”
Tell an agent
Replace message audit {id} with process {process} and body {body}.
Overwrite audit entry {id} in full for message {messageId}.
DELETE /api/v1/admin/MessageAudits({id}) Delete a message audit entry · Delete entity in EntitySet MessageAudits #
Ask an LLM
“How do I remove a single message audit record?”
“Can I delete an audit entry only if its ETag hasn't changed?”
Tell an agent destructive · confirm first
Delete message audit {id}.
Delete audit entry {id} if ETag is {etag}.
PATCH /api/v1/admin/MessageAudits({id}) Update a message audit entry · Update entity in EntitySet MessageAudits #
Ask an LLM
“How do I correct the recipient on a message audit record?”
“Can I change just the order linked to an audit entry?”
Tell an agent
Set the recipient of audit {id} to user {toUserProfileId}.
Link audit entry {id} to order {customerOrderId}.
GET /api/v1/admin/MessageAudits/Default.Default() Get the default message audit template · Call operation Default #
Ask an LLM
“What does a default message audit record look like?”
“Where do I get blank values for a new audit entry?”
Tell an agent
Get the default message audit template.
Show default fields for a new message audit.
DELETE /api/v1/admin/messageaudits/delete Bulk delete message audit entries · Message audits delete route #
Ask an LLM
“Is it possible to purge many message audit records at once?”
“Can I bulk delete audit entries by ID?”
Tell an agent destructive · confirm first
Bulk delete message audits {ids}.
Purge these audit log entries: {ids}.
GET /api/v1/admin/messageaudits({key})/customproperties({custompropertyKey}) Get a custom property on a message audit · Message audits get custom property by key and custompropertykey #
Ask an LLM
“Where would I read a custom property on a message audit record?”
“Can I fetch an extra attribute stored on an audit entry?”
Tell an agent
Get custom property {prop} on message audit {key}.
Show custom field {prop} for message audit {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-message-audits-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-message-audits-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-message-audits-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Message Audits API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Message Audits
paths:
  /api/v1/admin/MessageAudits:
    get:
      tags:
      - Message Audits
      summary: Returns the EntitySet MessageAudits
      operationId: MessageAudits_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:
      - Message Audits
      summary: Post a new entity to EntitySet MessageAudits
      operationId: MessageAudits_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.MessageAudit'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/MessageAudits({id}):
    get:
      tags:
      - Message Audits
      summary: Returns the entity with the key from MessageAudits
      operationId: MessageAudits_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:
      - Message Audits
      summary: Replace entity in EntitySet MessageAudits
      operationId: MessageAudits_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.MessageAudit'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Message Audits
      summary: Delete entity in EntitySet MessageAudits
      operationId: MessageAudits_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:
      - Message Audits
      summary: Update entity in EntitySet MessageAudits
      operationId: MessageAudits_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.MessageAudit'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/MessageAudits/Default.Default():
    get:
      tags:
      - Message Audits
      summary: Call operation Default
      operationId: MessageAudits_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/messageaudits/delete:
    delete:
      tags:
      - Message Audits
      operationId: MessageAudits_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: Message audits delete route
      x-summary-source: derived
  /api/v1/admin/messageaudits({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Message Audits
      operationId: MessageAudits_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: Message audits get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.MessageAudit:
      required:
      - process
      - body
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        messageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        process:
          maxLength: 50
          minLength: 0
          type: string
        fromUserProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        toUserProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        body:
          maxLength: 2000
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query