openapi: 3.2.0
info:
  title: Export API
  version: '1.0'
servers:
- url: https://api-exporter.openweb.com
tags:
- name: Export
paths:
  /v2/export/comments:
    post:
      summary: Request export
      responses:
        '200':
          $ref: '#/components/responses/PostExportResponse'
      parameters:
      - $ref: '#/components/parameters/apikey'
      requestBody:
        $ref: '#/components/requestBodies/PostExportCommentsRequest'
      tags:
      - Export
      operationId: postV2ExportComments
      x-operation-id-source: derived
  /v2/export/comments/abort:
    get:
      summary: Abort export
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
      description: Cancels the export
      parameters:
      - $ref: '#/components/parameters/id-v2'
      tags:
      - Export
      operationId: getV2ExportCommentsAbort
      x-operation-id-source: derived
  /v2/export/comments/list:
    get:
      summary: List finished exports
      responses:
        '200':
          description: OK
      description: Lists finished exports
      parameters:
      - $ref: '#/components/parameters/apikey'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      tags:
      - Export
      operationId: getV2ExportCommentsList
      x-operation-id-source: derived
  /v2/export/comments/status:
    get:
      summary: Check export status
      responses:
        '200':
          $ref: '#/components/responses/GetExportStatus'
      description: Retrieves the status of the export
      parameters:
      - $ref: '#/components/parameters/apikey'
      - $ref: '#/components/parameters/id-v2'
      tags:
      - Export
      operationId: getV2ExportCommentsStatus
      x-operation-id-source: derived
  /v4/export:
    post:
      summary: Request export
      responses:
        '202':
          $ref: '#/components/responses/PostExportResponse'
        '409':
          description: Same request already in progress
      parameters:
      - $ref: '#/components/parameters/jwt-token'
      - $ref: '#/components/parameters/x-spot-id'
      requestBody:
        $ref: '#/components/requestBodies/PostExportRequest'
      description: Initiates an export of comments, users, and ranks by Conversation ID or date range.
      tags:
      - Export
      operationId: postV4Export
      x-operation-id-source: derived
  /v4/export/abort:
    get:
      summary: Abort export
      responses:
        '202':
          description: Accepted
      description: Cancels the export
      parameters:
      - $ref: '#/components/parameters/jwt-token'
      - $ref: '#/components/parameters/id-v4'
      - $ref: '#/components/parameters/x-spot-id'
      tags:
      - Export
      operationId: getV4ExportAbort
      x-operation-id-source: derived
  /v4/export/list:
    get:
      summary: List finished exports
      responses:
        '200':
          description: OK
      description: Lists finished exports
      parameters:
      - $ref: '#/components/parameters/jwt-token'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/x-spot-id'
      tags:
      - Export
      operationId: getV4ExportList
      x-operation-id-source: derived
  /v4/export/status:
    get:
      summary: Check export status
      responses:
        '200':
          $ref: '#/components/responses/GetExportStatus'
      description: Retrieves the status of the export
      parameters:
      - $ref: '#/components/parameters/jwt-token'
      - $ref: '#/components/parameters/id-v4'
      - $ref: '#/components/parameters/x-spot-id'
      tags:
      - Export
      operationId: getV4ExportStatus
      x-operation-id-source: derived
components:
  parameters:
    id-v4:
      name: id
      in: query
      required: true
      schema:
        type: string
      description: Unique ID of an export request<br /><br /> This value is returned in the API response to a `POST /v4/export` call.
    offset:
      name: offset
      in: query
      required: true
      schema:
        type: string
      description: Offset for records
    limit:
      name: limit
      in: query
      required: true
      schema:
        type: string
      description: Limit of records returned
    apikey:
      name: apikey
      in: header
      required: true
      schema:
        type: string
      description: Unique OpenWeb export token<br /><br />Follow these steps to obtain the export token:<ol><li>From your OpenWeb Admin Dashboard, click <strong>Settings</strong>.</li><li>Under <strong>Authentication Tokens</strong>, click <strong>ApiKey</strong>.</li><li>Copy the key.</li></ol>
    jwt-token:
      name: Authorization
      in: header
      required: true
      schema:
        type: string
        example: 'Authorization: Bearer JWT_TOKEN'
      description: 'JWT token to be used for OpenWeb API


        You must obtain the JWT token by making a <a href="https://developers.openweb.com/reference/post_v1-publisher-auth" target="_blank">POST /v1/publisher/auth</a> call.


        In the API call, the JWT token must be preceded by the word `Bearer`.


        **Example**: `Authorization: Bearer JWT_TOKEN`

        '
    x-spot-id:
      name: x-spot-id
      in: header
      required: true
      schema:
        type: string
      description: Unique OpenWeb identifier for the property from which data is requested<br /><br />If you do not know your OpenWeb spot ID, please contact your OpenWeb representative.
    id-v2:
      name: id
      in: query
      required: false
      schema:
        type: string
      description: Unique ID of an export request<br /><br /> This value is returned in the API response to a `POST /v2/export/comments` call.
  responses:
    GetExportStatus:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            x-examples:
              Example 1:
                links:
                - '...'
                - '...'
                - '...'
                status: done
                status_link: https://api.openweb.com/v4/export/status?id=EXPORT_REQUEST_ID
            properties:
              links:
                type: array
                description: 'Secured URLs to an export download, present only when `"status": "done"`'
                items:
                  type: string
              status:
                description: State of the export request
                type: string
                enum:
                - aborted
                - done
                - failed
                - in_progress
                - pending
    PostExportResponse:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            x-examples:
              Example 1:
                status_link: STATUS_LINK
                status: pending
                request_id: REQUEST_ID
            properties:
              request_id:
                type: string
                description: Unique ID of the export request
              status:
                description: State of the export request
                type: string
                enum:
                - pending
              status_link:
                type: string
                description: Check status endpoint
          examples:
            Example 1:
              value:
                request_id: REQUEST_ID
                status: pending
                status_link: STATUS_LINK
  schemas:
    from:
      title: from
      type: string
      description: Start date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
    delimiter:
      type: string
      description: 'Character that separates individual data fields within each row of the .csv file


        By default, OpenWeb uses `,`.

        '
      enum:
      - ','
      - ;
    until:
      title: until
      type: string
      description: End date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
    conversation-id-option:
      title: Conversation ID
      type: object
      required:
      - conversation_id
      properties:
        conversation_id:
          $ref: '#/components/schemas/conversation-id'
        delimiter:
          $ref: '#/components/schemas/delimiter'
        from:
          $ref: '#/components/schemas/from'
        max_records_in_file:
          $ref: '#/components/schemas/max_records_in_file'
        until:
          $ref: '#/components/schemas/until'
    date-range-option:
      title: Date Range
      type: object
      required:
      - from
      - until
      properties:
        from:
          $ref: '#/components/schemas/from'
        until:
          $ref: '#/components/schemas/until'
        conversation_id:
          $ref: '#/components/schemas/conversation-id'
        delimiter:
          $ref: '#/components/schemas/delimiter'
        max_records_in_file:
          $ref: '#/components/schemas/max_records_in_file'
    max_records_in_file:
      type: integer
      maximum: 100000
      example: 10000
      description: Number of records per one .csv file
    conversation-id:
      title: conversation_id
      type: string
      description: 'ID of the Conversation from which data is requested


        Use one of these approaches to obtain this value:


        <strong>Article Card</strong>

        1. From your OpenWeb Admin Panel, click **Moderation > Articles**.

        2. Search for a comment associated with the Conversation.

        3. On the comment card, click **More > Copy conversation ID to clipboard**.


        <strong>Code</strong>

        1. Locate the spot ID. Contact your OpenWeb representative if you do not know this value.

        2. Identify the post ID. This is the unique article identifier assigned to the article page when it is created.

        3. Concatenate the spot ID and postID with an underscore

        ```

        spotID_postID

        ```


        <strong>Comment Card</strong>

        1. From your OpenWeb Admin Panel, click **Moderation > Comments**.

        2. Search for a comment associated with the Conversation.

        3. On the comment card, click **More > Copy conversation ID to clipboard**.


        </details>'
  requestBodies:
    PostExportRequest:
      content:
        application/json:
          schema:
            x-examples:
              Example 1:
                from: '2022-07-30T00:00:00Z'
                until: '2022-07-30T23:59:00Z'
                spot_id: SPOT_ID
                conversation_id: CONVERSATION_ID
            oneOf:
            - $ref: '#/components/schemas/date-range-option'
            - $ref: '#/components/schemas/conversation-id-option'
    PostExportCommentsRequest:
      content:
        application/json:
          schema:
            type: object
            x-examples:
              Example 1:
                since: '2022-07-30T00:00:00Z'
                to: '2022-07-30T23:59:00Z'
            required:
            - since
            - to
            properties:
              since:
                type: string
                description: Start date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
                example: '2018-12-01T00:00:00Z'
              to:
                type: string
                example: '2018-12-02T00:00:00Z'
                description: 'End date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format


                  If not set, the default value is the current date and time.'
x-provenance:
  method: searched
  source: https://developers.openweb.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.openweb.com/reference/get_v2-export-comments-abort.md
  - https://developers.openweb.com/reference/get_v2-export-comments-list.md
  - https://developers.openweb.com/reference/get_v2-export-comments-status.md
  - https://developers.openweb.com/reference/get_v4-export-abort.md
  - https://developers.openweb.com/reference/get_v4-export-list.md
  - https://developers.openweb.com/reference/get_v4-export-status.md
  - https://developers.openweb.com/reference/post_v2-export-comments.md
  - https://developers.openweb.com/reference/post_v4-export.md
  merge:
    pages: 8
    deduped: 14
    conflicts_kept_first: 0