Adobe Analytics Job API

openapi: 3.2.0
info:
  title: Adobe Analytics Data Sources Job API
  description: A service for managing and uploading data to Data Sources accounts.
  version: '1.0'
servers:
- url: https://analytics.adobe.io/api
tags:
- name: Job
  description: Upload and monitor data of Data Sources accounts
paths:
  /{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}:
    get:
      tags:
      - Job
      summary: Retrieve information for jobs uploaded to a Data Sources account.
      description: Retrieves information for jobs uploaded to a Data Sources account associated with the given report suite. The results can be filtered by several criteria and are paginated at 100 entries per page.
      operationId: getJobs
      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: report_suite_id
        in: path
        description: The report suite ID associated with the Data Sources account
        required: true
        schema:
          type: string
      - name: data_source_id
        in: path
        description: The Data Source account ID associated with the search for jobs
        required: true
        schema:
          type: string
      - name: status
        in: query
        description: The status of jobs being searched
        schema:
          type: string
        example: uploaded
      - name: start_date
        in: query
        description: 'How far back to begin the search. Should be earlier than ''end_date''. Defaults to one month ago. Format: ''yyyy-mm-dd hh:mm:ss'''
        schema:
          type: string
      - name: end_date
        in: query
        description: 'How far back to end the search. Should be more recent than ''start_date''. Defaults to today. Format: ''yyyy-mm-dd hh:mm:ss'''
        schema:
          type: string
      - name: page
        in: query
        description: Which page of the results to retrieve. Page '1' is the first page. If this value exceeds the available pages, no results will be returned.
        schema:
          type: string
        example: 1
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDataSourcesJobList'
      security:
      - global_company_id: []
      - ims_user_token: []
    post:
      tags:
      - Job
      summary: Upload data to a Data Sources account.
      description: Uploads a data file to a Data Sources account associated with the given report suite. The file must be formatted identically to files uploaded to Data Sources FTP accounts. A job is created, which can be queried later by its job ID. File validation will be performed at the time the job is processed, not upon upload.
      operationId: createJob
      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: report_suite_id
        in: path
        description: The report suite ID associated with the Data Sources account
        required: true
        schema:
          type: string
      - name: data_source_id
        in: path
        description: The Data Source ID of the account to receive the file
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            examples:
              file:
                description: A file formatted to be imported to Data Sources
                value: 'date    event 1 evar 1

                  1/1/2024    1   Test Data 1

                  1/1/2024    2   Test Data 2

                  '
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourcesJob'
      security:
      - global_company_id: []
      - ims_user_token: []
  /{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}/{job_id}:
    get:
      tags:
      - Job
      summary: Retrieve information for a specific job uploaded to a Data Sources account.
      description: Retrieve information for a specific job uploaded to a Data Sources account for a given report suite. The Job is identified by its job ID.
      operationId: getJob
      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: report_suite_id
        in: path
        description: The report suite ID associated with the Data Sources account
        required: true
        schema:
          type: string
      - name: data_source_id
        in: path
        description: The Data Source ID associated with the job
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: The job ID of the job to retrieve.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourcesJob'
      security:
      - global_company_id: []
      - ims_user_token: []
components:
  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
  schemas:
    DataSourcesJob:
      type: object
      properties:
        filename:
          type: string
          description: The original name of the file
          example: my_data_file.txt
        rows:
          type: integer
          description: The number of rows successfully processed
          format: int64
          example: 100
        job_id:
          type: integer
          format: int64
          example: 12345
        status:
          type: string
          example: processing
        uploaded_date:
          type: string
          example: 1999/12/31 23:59:59
        started_processing_date:
          type: string
          example: 1999/12/31 23:59:59
        finished_processing_date:
          type: string
          example: 1999/12/31 23:59:59
    PagedDataSourcesJobList:
      type: object
      properties:
        page:
          type: integer
          format: int64
          example: 1
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/DataSourcesJob'
        total_pages:
          type: integer
          format: int64
          example: 1
  securitySchemes:
    global_company_id:
      type: apiKey
      description: An Adobe global company ID
      name: x-proxy-global-company-id
      in: header
    ims_user_token:
      type: http
      description: An Adobe IMS user access token
      scheme: Bearer