Optimizely Audits API

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

Documentation 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/Audits List admin audit log entries · Returns the EntitySet Audits #

Ask an LLM

“What actions have admins taken in Optimizely Commerce recently?”

“Can I filter the audit log by user name or IP address?”

Tell an agent

List all audit log entries.

Show audit entries matching {filter}, newest first by {orderby}.

POST /api/v1/admin/Audits Record an audit log entry · Post a new entity to EntitySet Audits #

Ask an LLM

“Can I write my own entry into the audit trail?”

“Which details, like user, IP and action, does a new audit record need?”

Tell an agent

Log audit action {action} by {userName} from {ipAddress} described as {description}.

Record an audit entry dated {auditDate} for user {userName} doing {action} from {ipAddress}: {description}.

GET /api/v1/admin/Audits({id}) Get one audit log entry · Returns the entity with the key from Audits #

Ask an LLM

“Who performed a particular audited action, and from where?”

“Can I pull up a single audit record by id?”

Tell an agent

Fetch audit entry {id}.

Show the user, action and IP of audit record {id}.

PUT /api/v1/admin/Audits({id}) Replace an audit log entry · Replace entity in EntitySet Audits #

Ask an LLM

“Can an audit record be overwritten in full?”

“Does replacing an audit entry require resending the user, IP and action?”

Tell an agent

Replace audit entry {id} with action {action} by {userName}.

Overwrite the full record of audit entry {id}.

DELETE /api/v1/admin/Audits({id}) Delete one audit log entry · Delete entity in EntitySet Audits #

Ask an LLM

“Is it possible to delete a single audit trail record?”

“Can deleting an audit entry be guarded by its ETag?”

Tell an agent destructive · confirm first

Delete audit entry {id}.

Delete audit record {id} only if its ETag is {etag}.

PATCH /api/v1/admin/Audits({id}) Edit fields of an audit log entry · Update entity in EntitySet Audits #

Ask an LLM

“Can I correct just the description on an existing audit record?”

“Is a partial update allowed on audit entries?”

Tell an agent

Change the description of audit entry {id} to {description}.

Set the audit date of entry {id} to {auditDate}.

GET /api/v1/admin/Audits/Default.Default() Get default values for an audit entry · Call operation Default #

Ask an LLM

“What defaults does a new audit record start with?”

“Is there a blank audit entry template?”

Tell an agent

Get the default field values for a new audit entry.

Show the empty audit record template.

DELETE /api/v1/admin/audits/delete Bulk delete audit log entries · Audits delete route #

Ask an LLM

“Can I purge many audit records in one request?”

“Is there a batch delete for audit entries by id list?”

Tell an agent destructive · confirm first

Bulk delete audit entries {ids}.

Permanently delete every audit record in {ids}.

GET /api/v1/admin/audits({key})/customproperties({custompropertyKey}) Get a custom property on an audit entry · Audits get custom property by key and custompropertykey #

Ask an LLM

“How can I read a custom property stored on an audit record?”

“Can I fetch one custom field value from an audit entry?”

Tell an agent

Get custom property {custompropertyKey} of audit entry {key}.

Show the {custompropertyKey} custom property on audit record {key}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-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-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

openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Audits API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Audits
paths:
  /api/v1/admin/Audits:
    get:
      tags:
      - Audits
      summary: Returns the EntitySet Audits
      operationId: Audits_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:
      - Audits
      summary: Post a new entity to EntitySet Audits
      operationId: Audits_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Audit'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Audits({id}):
    get:
      tags:
      - Audits
      summary: Returns the entity with the key from Audits
      operationId: Audits_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:
      - Audits
      summary: Replace entity in EntitySet Audits
      operationId: Audits_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.Audit'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Audits
      summary: Delete entity in EntitySet Audits
      operationId: Audits_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:
      - Audits
      summary: Update entity in EntitySet Audits
      operationId: Audits_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.Audit'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Audits/Default.Default():
    get:
      tags:
      - Audits
      summary: Call operation Default
      operationId: Audits_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/audits/delete:
    delete:
      tags:
      - Audits
      operationId: Audits_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: Audits delete route
      x-summary-source: derived
  /api/v1/admin/audits({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Audits
      operationId: Audits_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: Audits get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Audit:
      required:
      - userName
      - ipAddress
      - action
      - description
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        auditDate:
          format: date-time
          type: string
        userName:
          maxLength: 255
          minLength: 0
          type: string
        ipAddress:
          maxLength: 255
          minLength: 0
          type: string
        action:
          maxLength: 255
          minLength: 0
          type: string
        description:
          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