Adobe Analytics

Adobe Analytics Classification Job API

The Classification Job API from Adobe Analytics — 10 operation(s) for classification job.

GitHub OpenAPI

Operations 10

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

POST /{globalCompanyId}/classification/job/import/commitApiJob/{api_job_id} Commit a classification import job · Commit API import job for processing #
Ask an LLM
“After uploading my classification file, how do I start processing the import?”
“How do I tell Analytics an API import job is ready to run?”
Tell an agent
Commit classification import job {api_job_id} in company {globalCompanyId} for processing.
Submit API import job {api_job_id} now that its file is uploaded.
POST /{globalCompanyId}/classification/job/import/createApiJob/{dataset_id} Start a file-based classification import job · Create API import job entity on classification dataset #
Ask an LLM
“How do I begin a classification import that I'll upload a file to afterwards?”
“Can I set the data format and encoding for a classification file import?”
Tell an agent
Create an API import job named {jobName} on classification dataset {dataset_id} in company {globalCompanyId}.
Open a {dataFormat} file import job on dataset {dataset_id} with encoding {encoding}.
POST /{globalCompanyId}/classification/job/export/{dataset_id} Export classification data · Create export job for one dataset #
Ask an LLM
“How do I export the classification values from a dataset?”
“Is there a row limit when exporting classification data?”
Tell an agent
Export classification dataset {dataset_id} in company {globalCompanyId} as job {jobName}.
Export up to {rowLimit} rows from classification dataset {dataset_id} where keys match {keyRegex}.
POST /{globalCompanyId}/classification/job/import/json/{dataset_id} Import classification data as JSON · Create API import job classification dataset with JSON format data #
Ask an LLM
“Can I send classification values directly as JSON instead of uploading a file?”
“What's the size limit for a JSON classification import?”
Tell an agent
Import JSON classification data {data} into dataset {dataset_id} in company {globalCompanyId}.
Run a JSON import job {jobName} on classification dataset {dataset_id}.
GET /{globalCompanyId}/classification/job/byDataset/{dataset_id} List classification jobs for a dataset · Retrieve classification jobs for specified dataset #
Ask an LLM
“What import and export jobs have run on my classification dataset recently?”
“Can I look back a set number of days for classification jobs?”
Tell an agent
List classification jobs for dataset {dataset_id} in company {globalCompanyId}.
Show classification jobs on dataset {dataset_id} from the last {lookbackDays} days.
GET /{globalCompanyId}/classification/job/{job_id} Get a classification job's status · Retrieve classification job by job ID #
Ask an LLM
“Did my classification import job finish?”
“How do I check on a single classification job by its job ID?”
Tell an agent
Get classification job {job_id} in company {globalCompanyId}.
Check the status of classification job {job_id}.
GET /{globalCompanyId}/classification/job/export/file/{job_id} Download a classification export file · Retrieve export file by export job ID #
Ask an LLM
“How do I download the file my classification export job produced?”
“Where do I get the output of a finished classification export?”
Tell an agent
Download the export file for classification job {job_id} in company {globalCompanyId}.
Fetch the classification export output of job {job_id}.
GET /{globalCompanyId}/classification/job/export/file/{job_id}/{file_name} Download one named classification export file · Retrieve export file by export job ID and file name #
Ask an LLM
“If an export job produced several files, how do I download a specific one by name?”
“Can I grab just one file from a multi-file classification export?”
Tell an agent
Download file {file_name} from classification export job {job_id} in company {globalCompanyId}.
Get export file {file_name} produced by job {job_id}.
GET /{globalCompanyId}/classification/job/export/file/{job_id}/list List files from a classification export · Retrieve export file list by export job ID #
Ask an LLM
“What files did my classification export job generate?”
“How do I see the file names an export job produced before downloading?”
Tell an agent
List the export files for classification job {job_id} in company {globalCompanyId}.
Show the file names created by export job {job_id}.
POST /{globalCompanyId}/classification/job/import/uploadFile/{api_job_id} Upload a file to a classification import job · Upload File for API import job #
Ask an LLM
“How do I attach my classification data file to an import job I created?”
“What is the maximum file size for a classification import upload?”
Tell an agent
Upload the classification file to import job {api_job_id} in company {globalCompanyId}.
Attach my data file to API import job {api_job_id}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adobe-analytics/refs/heads/main/openapi/adobe-analytics-classification-job-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/adobe-analytics:adobe-analytics-classification-job-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

adobe-analytics-classification-job-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Adobe Analytics Classification Classification Job API
  description: 'Adobe Analytics Classification API 2.0


    Note: Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning.'
  version: v1
servers:
- url: https://analytics.adobe.io/api
tags:
- name: Classification Job
paths:
  /{globalCompanyId}/classification/job/import/commitApiJob/{api_job_id}:
    post:
      tags:
      - Classification Job
      summary: Commit API import job for processing
      operationId: commitApiImportJob
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: api_job_id
        in: path
        description: The API Job Id for uploading file
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully committed API import job for processing
        '400':
          description: The API job status is not FILE_UPLOADED, need to upload file first before commit the API job
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: The API Job Id doesn't exist in the IMS ORG
  /{globalCompanyId}/classification/job/import/createApiJob/{dataset_id}:
    post:
      tags:
      - Classification Job
      summary: Create API import job entity on classification dataset
      description: Create API import job entity on classification dataset, need to upload file after this API call
      operationId: createApiJobEntity
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: dataset_id
        in: path
        description: The dataset id for creating import job
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiJobImportOptions'
      responses:
        '200':
          description: Successfully created API import job entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportApiJobRecord'
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: The dataset doesn't exist in the IMS ORG
  /{globalCompanyId}/classification/job/export/{dataset_id}:
    post:
      tags:
      - Classification Job
      summary: Create export job for one dataset
      description: Create export job for one dataset, the row limit should be less than 50,000
      operationId: createExportJob
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: dataset_id
        in: path
        description: The dataset id for creating API export job
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiJobExportOptions'
      responses:
        '200':
          description: Successfully created export job for one dataset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiClassificationJob'
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: The dataset doesn't exist in the IMS ORG
  /{globalCompanyId}/classification/job/import/json/{dataset_id}:
    post:
      tags:
      - Classification Job
      summary: Create API import job classification dataset with JSON format data
      description: Create API import job classification dataset with JSON format data, the JSON data size should be less than 50MB
      operationId: createJsonImportJob
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: dataset_id
        in: path
        description: The dataset id for creating API import job
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobImportOptionsWithData'
      responses:
        '200':
          description: Successfully created API import job for classification dataset
        '400':
          description: The uploaded file size exceeds the limit or the dataFormat is not JSON
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: The dataset doesn't exist in the IMS ORG
        '500':
          description: Internal server error, upload file to internal storage failed
  /{globalCompanyId}/classification/job/byDataset/{dataset_id}:
    get:
      tags:
      - Classification Job
      summary: Retrieve classification jobs for specified dataset
      operationId: findJobsByDataset
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: dataset_id
        in: path
        description: Classification Dataset ID
        required: true
        schema:
          type: string
      - name: lookbackDays
        in: query
        description: Look back Windows (Days)
        schema:
          type: integer
          format: int32
          default: 30
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The page size
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: Successfully retrieved classification job for specified dataset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiClassificationJobPage'
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: Cannot find job for specified dataset
  /{globalCompanyId}/classification/job/{job_id}:
    get:
      tags:
      - Classification Job
      summary: Retrieve classification job by job ID
      operationId: getJobById
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: job_id
        in: path
        description: Classification Job ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved classification job by job ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiClassificationJob'
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: Cannot find job in the IMS ORG
  /{globalCompanyId}/classification/job/export/file/{job_id}:
    get:
      tags:
      - Classification Job
      summary: Retrieve export file by export job ID
      operationId: retrieveArtifact
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: job_id
        in: path
        description: Export Job ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved export file by export job ID
        '400':
          description: The export job is not complete and the file is not ready to download
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: Cannot find job in the IMS ORG
  /{globalCompanyId}/classification/job/export/file/{job_id}/{file_name}:
    get:
      tags:
      - Classification Job
      summary: Retrieve export file by export job ID and file name
      operationId: retrieveArtifactById
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: job_id
        in: path
        description: Export Job ID
        required: true
        schema:
          type: string
      - name: file_name
        in: path
        description: File Name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved export file by export job ID and file name
        '400':
          description: The export job is not complete and the file is not ready to download
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: Cannot find job in the IMS ORG
  /{globalCompanyId}/classification/job/export/file/{job_id}/list:
    get:
      tags:
      - Classification Job
      summary: Retrieve export file list by export job ID
      operationId: retrieveArtifactList
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: job_id
        in: path
        description: Export Job ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved export file list by export job ID
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: Cannot find job in the IMS ORG
  /{globalCompanyId}/classification/job/import/uploadFile/{api_job_id}:
    post:
      tags:
      - Classification Job
      summary: Upload File for API import job
      description: Upload File for one API import job, the file size limit is 50MB
      operationId: uploadImportFile
      parameters:
      - name: globalCompanyId
        in: path
        description: The Global Company ID for the Adobe Analytics organization
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - name: api_job_id
        in: path
        description: The API Job Id for uploading file
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully uploaded file for API import job
        '400':
          description: The uploaded file size exceeds the limit
        '403':
          description: User does not have classification permission to perform this action
        '404':
          description: The API Job Id doesn't exist or the dataset doesn't exist in the IMS ORG
        '500':
          description: Internal server error, upload file to internal storage failed
components:
  schemas:
    JsonRecord:
      type: object
      properties:
        key:
          type: string
        action:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
    ApiJobExportOptions:
      type: object
      properties:
        dataFormat:
          type: string
        encoding:
          type: string
        jobName:
          type: string
        listDelimiter:
          type: string
        rowLimit:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        columns:
          type: array
          items:
            type: string
        keys:
          type: array
          items:
            type: string
        keyRegex:
          type: string
        exactMatch:
          type: object
          additionalProperties:
            type: object
        regexMatch:
          type: object
          additionalProperties:
            type: object
        dateFilterStart:
          type: string
        dateFilterEnd:
          type: string
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
    NotificationExtra:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    KeyOption:
      type: object
      properties:
        byte_length:
          type: integer
          format: int32
        type:
          type: string
        overwrite:
          type: boolean
    ApiJobImportOptions:
      type: object
      properties:
        dataFormat:
          type: string
        encoding:
          type: string
        jobName:
          type: string
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        listDelimiter:
          type: string
        keyOptions:
          $ref: '#/components/schemas/KeyOption'
    ApiClassificationJob:
      properties:
        setName:
          type: string
          description: The name of the classification dataset.
        jobId:
          type: string
          description: The id of the job.
        jobSize:
          type: integer
          description: The size of the job file
          format: int64
        jobOptions:
          type: object
          description: The import or export options of the job.
        name:
          type: string
          description: The name of the job.
        totalLines:
          type: integer
          description: The total lines of the file.
          format: int32
        datasetId:
          type: string
          description: The classification dataset id of the job.
        noeffectLines:
          type: integer
          description: The no effect lines of import job.
          format: int32
        history:
          type: array
          description: The history of the job.
          items:
            $ref: '#/components/schemas/ApiJobHistory'
        state:
          type: string
          description: The state of the job.
        type:
          type: string
          description: The type of the job.
        imsOrgId:
          type: string
          description: The IMS Org Id of the job.
    Notification:
      type: object
      properties:
        method:
          type: string
          enum:
          - email
          - rabbit
        state:
          type: string
          enum:
          - created
          - queued
          - validated
          - failed_validation
          - processing
          - done_processing
          - failed_processing
          - completed
        recipients:
          type: array
          items:
            type: string
      description: List of notifications to be sent for all imports and exports that occur.
    ImportApiJobRecord:
      properties:
        api_job_status:
          type: string
        dataset_id:
          type: string
        api_job_id:
          type: string
        ims_org_id:
          type: string
        taxonomist_job_id:
          type: string
        job_options:
          $ref: '#/components/schemas/JobImportOptions'
    JobImportOptions:
      type: object
      properties:
        dataFormat:
          type: string
        encoding:
          type: string
        jobName:
          type: string
        fileBasename:
          type: string
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        statesWithQueuedNotifications:
          type: array
          items:
            type: string
        listDelimiter:
          type: string
        pipelineTag:
          type: string
        source:
          type: string
        dataUri:
          type: string
        originalDataUri:
          type: string
        keyOptions:
          $ref: '#/components/schemas/KeyOption'
        notification_extras:
          type: array
          items:
            $ref: '#/components/schemas/NotificationExtra'
    JobImportOptionsWithData:
      type: object
      properties:
        dataFormat:
          type: string
        encoding:
          type: string
        jobName:
          type: string
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        listDelimiter:
          type: string
        keyOptions:
          $ref: '#/components/schemas/KeyOption'
        jobImportOption:
          $ref: '#/components/schemas/JobImportOptions'
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonRecord'
    ApiClassificationJobPage:
      properties:
        size:
          type: integer
          format: int32
        numberOfElements:
          type: integer
          format: int32
        last:
          type: boolean
        totalPages:
          type: integer
          format: int32
        page:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/ApiClassificationJob'
        first:
          type: boolean
        totalElements:
          type: integer
          format: int64
    ApiJobHistory:
      type: object
      properties:
        timestamp:
          type: string
          description: The time when the job state changed
        jobState:
          type: string
          description: The state of the job
          enum:
          - created
          - queued
          - validated
          - failed_validation
          - processing
          - done_processing
          - failed_processing
          - completed
        message:
          type: string
          description: The details of the job history
      description: The history of the job.
  parameters:
    x-api-key:
      name: x-api-key
      in: header
      description: The API key copied from your AA API client integration. For more information on how to obtain this value, see [Getting started with the CJA API](https://developer.adobe.com/cja-apis/docs/getting-started/).
      required: true
      schema:
        type: string
    authorization:
      name: Authorization
      in: header
      description: The access token copied from your AA API client integration, prefixed with "Bearer ".
      required: true
      schema:
        type: string