Optimizely

Optimizely Integration Jobs API

The Integration Jobs API from Optimizely — 7 operation(s) for integration jobs.

GitHub OpenAPI

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/IntegrationJobs List integration job runs · Returns the EntitySet IntegrationJobs #
Ask an LLM
“How can I see recent integration job runs and their status?”
“Can I filter job runs to failed ones or count how many ran today?”
Tell an agent
List all integration job runs.
List integration jobs matching {filter}, newest first by {orderby}, top {top}.
POST /api/v1/admin/IntegrationJobs Queue an integration job · Post a new entity to EntitySet IntegrationJobs #
Ask an LLM
“Can I kick off a new run of an existing job definition?”
“Is it possible to schedule an integration job for a later time?”
Tell an agent
Create an integration job for definition {jobDefinitionId} with status {status}.
Schedule job definition {jobDefinitionId} to run at {scheduleDateTime}.
GET /api/v1/admin/IntegrationJobs({id}) Get an integration job run · Returns the entity with the key from IntegrationJobs #
Ask an LLM
“How many records did a specific integration job add, modify or delete?”
“Can I check the error and warning counts of one job run?”
Tell an agent
Show integration job {id}.
Get integration job {id} returning only {select}.
PUT /api/v1/admin/IntegrationJobs({id}) Replace an integration job record · Replace entity in EntitySet IntegrationJobs #
Ask an LLM
“Can I overwrite a whole integration job record?”
“What's the full-replace call for a job run?”
Tell an agent
Replace integration job {id} with status {status} and notes {notes}.
Overwrite integration job {id} entirely for definition {jobDefinitionId}.
DELETE /api/v1/admin/IntegrationJobs({id}) Delete an integration job run · Delete entity in EntitySet IntegrationJobs #
Ask an LLM
“How do I remove one integration job run from history?”
“Can I delete a job run only if it hasn't changed since I read it?”
Tell an agent destructive · confirm first
Delete integration job {id}.
Delete integration job {id} if its ETag is {etag}.
PATCH /api/v1/admin/IntegrationJobs({id}) Update an integration job's status · Update entity in EntitySet IntegrationJobs #
Ask an LLM
“Can I change only the status of an integration job run?”
“Is there a partial update to add notes to a job?”
Tell an agent
Set integration job {id} status to {status}.
Add notes {notes} to integration job {id}.
GET /api/v1/admin/IntegrationJobs/Default.Default() Get default values for an integration job · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new integration job?”
“Is there a blank template for an integration job run?”
Tell an agent
Get the default integration job template.
Show pre-filled values for a new integration job.
DELETE /api/v1/admin/integrationjobs/delete Delete several integration job runs · Integration jobs delete route #
Ask an LLM
“Can I purge a batch of old integration job runs at once?”
“Which call bulk removes integration jobs by ID?”
Tell an agent destructive · confirm first
Bulk delete integration jobs {ids}.
Purge the integration job runs {ids}.
GET /api/v1/admin/integrationjobs({key})/customproperties({custompropertyKey}) Get a custom property on an integration job · Integration jobs get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom field stored on an integration job run?”
“Where are extra attributes of a job run kept?”
Tell an agent
Get custom property {custompropertyKey} on integration job {key}.
Show integration job {key}'s custom field {custompropertyKey}.
GET /api/v1/admin/integrationjobs({key})/integrationjoblogs({integrationjoblogKey}) Get a log entry from an integration job · Integration jobs get integration job log by key and integrationjoblogkey #
Ask an LLM
“Can I read a single log message written during an integration job run?”
“Where do I see why a job run logged an error?”
Tell an agent
Get log entry {integrationjoblogKey} of integration job {key}.
Show integration job {key}'s log line {integrationjoblogKey}.
GET /api/v1/admin/integrationjobs({key})/integrationjobparameters({integrationjobparameterKey}) Get a parameter used by an integration job · Integration jobs get integration job parameter by key and… #
Ask an LLM
“What parameter value was a specific integration job run started with?”
“Can I read one runtime parameter on a job run?”
Tell an agent
Get parameter {integrationjobparameterKey} of integration job {key}.
Show integration job {key}'s runtime parameter {integrationjobparameterKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-integration-jobs-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-integration-jobs-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-integration-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Integration Jobs API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Integration Jobs
paths:
  /api/v1/admin/IntegrationJobs:
    get:
      tags:
      - Integration Jobs
      summary: Returns the EntitySet IntegrationJobs
      operationId: IntegrationJobs_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:
      - Integration Jobs
      summary: Post a new entity to EntitySet IntegrationJobs
      operationId: IntegrationJobs_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.IntegrationJob'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/IntegrationJobs({id}):
    get:
      tags:
      - Integration Jobs
      summary: Returns the entity with the key from IntegrationJobs
      operationId: IntegrationJobs_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:
      - Integration Jobs
      summary: Replace entity in EntitySet IntegrationJobs
      operationId: IntegrationJobs_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.IntegrationJob'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Integration Jobs
      summary: Delete entity in EntitySet IntegrationJobs
      operationId: IntegrationJobs_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:
      - Integration Jobs
      summary: Update entity in EntitySet IntegrationJobs
      operationId: IntegrationJobs_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.IntegrationJob'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/IntegrationJobs/Default.Default():
    get:
      tags:
      - Integration Jobs
      summary: Call operation Default
      operationId: IntegrationJobs_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/integrationjobs/delete:
    delete:
      tags:
      - Integration Jobs
      operationId: IntegrationJobs_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: Integration jobs delete route
      x-summary-source: derived
  /api/v1/admin/integrationjobs({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Integration Jobs
      operationId: IntegrationJobs_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: Integration jobs get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/integrationjobs({key})/integrationjoblogs({integrationjoblogKey}):
    get:
      tags:
      - Integration Jobs
      operationId: IntegrationJobs_GetIntegrationJobLogByKeyAndIntegrationjoblogkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: integrationjoblogKey
        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: Integration jobs get integration job log by key and integrationjoblogkey
      x-summary-source: derived
  /api/v1/admin/integrationjobs({key})/integrationjobparameters({integrationjobparameterKey}):
    get:
      tags:
      - Integration Jobs
      operationId: IntegrationJobs_GetIntegrationJobParameterByKeyAndIntegrationjobparameterkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: integrationjobparameterKey
        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: Integration jobs get integration job parameter by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.IntegrationJob:
      required:
      - status
      - notes
      - resultData
      - initialData
      - datasetFileLocation
      - exportObject
      - exportQuery
      - exportColumnList
      - siteUrl
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        jobDefinitionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        startDateTime:
          format: date-time
          type: string
        endDateTime:
          format: date-time
          type: string
        duration:
          format: decimal
          type: number
        status:
          maxLength: 255
          minLength: 0
          type: string
        recordCount:
          format: int32
          type: integer
        notes:
          type: string
        dataSize:
          format: decimal
          type: number
        isRealTime:
          type: boolean
        resultData:
          type: string
        isPreview:
          type: boolean
        jobNumber:
          format: int32
          type: integer
        deltaDataSetProcessed:
          type: boolean
        scheduleDateTime:
          format: date-time
          type: string
        previewStepSequence:
          format: int32
          type: integer
        fileProcessed:
          type: boolean
        runStandalone:
          type: boolean
        warningCount:
          format: int32
          type: integer
        errorCount:
          format: int32
          type: integer
        datasetFileLocation:
          maxLength: 255
          minLength: 0
          type: string
        retryCounter:
          format: int32
          type: integer
        retryStartingFrom:
          format: int32
          type: integer
        recordsAdded:
          format: int32
          type: integer
        recordsModified:
          format: int32
          type: integer
        recordsDeleted:
          format: int32
          type: integer
        isActive:
          type: boolean
        exportObject:
          type: string
        exportQuery:
          type: string
        exportColumnList:
          type: string
        siteUrl:
          type: string
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        host:
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
        initialData:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query