Adobe Suite Preview API

openapi: 3.2.0
info:
  title: Data Access Preview API
  description: Data Access supports limited data egress from Adobe Experience Platform for very particular synchronous use cases.
  version: 1.0.0
servers:
- url: https://{environment}.adobe.io/data/foundation/export
  description: Adobe IO gateway endpoint
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Preview
  description: Retrieve the first 100 rows of CSV or Parquet files.
paths:
  /datasets/{id}/preview:
    get:
      tags:
      - Preview
      summary: Preview the files
      description: This endpoint lets you preview the first 100 rows of the retrieved CSV or Parquet files.
      operationId: retrieveDatasetPreview
      parameters:
      - name: id
        in: path
        description: The ID of the dataset you want to preview.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        200:
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview'
        401:
          description: Access is unauthorized.
          content: {}
        404:
          description: The requested dataset was not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
components:
  parameters:
    x-api-key:
      name: x-api-key
      in: header
      description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    authorization:
      name: Authorization
      in: header
      description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-sandbox-name:
      name: x-sandbox-name
      in: header
      description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
      required: true
      schema:
        type: string
    x-gw-ims-org-id:
      name: x-gw-ims-org-id
      in: header
      description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
  schemas:
    preview:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/row'
    row:
      type: object
      properties:
        column1:
          type: string
        column2:
          type: string
        column3:
          type: string