Meltwater Listening Exports API

openapi: 3.0.3
info:
  title: Meltwater Account Management Listening Exports API
  description: The Meltwater Public API
  contact:
    name: Meltwater Support
    url: https://developer.meltwater.com/
    email: support@api.meltwater.com
  version: '1.0'
servers:
- url: https://api.meltwater.com
security:
- apikey: []
tags:
- name: Listening Exports
  description: Data exports for onetime and recurring jobs.
  parent: Listening
paths:
  /v3/exports/one-time:
    post:
      tags:
      - Listening Exports
      summary: Creates a new one-time export
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneTimeExportResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                title: Bad Request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: Invalid data
                    details: Invalid JSON payload
                description: Bad Request
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                title: Unauthorized request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: AUTH
                    title: Unauthorized
                    details: Invalid or expired authorization header
                description: Unauthorized request
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                type: object
                title: Permission denied
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: ENTITLEMENT
                    title: Entitlement missing
                    details: 'You are missing required entitlements, in order to access given content: ["news", "social"]. Please contact your sales representative to add the necessary entitlement to your Meltwater account.'
                description: Permission denied
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                title: Not Found
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: EXPORT
                    title: Unknown resource
                    details: The resource id you provided (1234) is unknown
                description: Not Found
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                title: Unprocessable entity
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: 'Validation error for field: window_size'
                    details: is not a valid integer
                description: Unprocessable entity
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                title: Internal Server Error
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: INTERNAL
                    title: Internal Server error
                    details: Something went wrong behind the scenes...
                description: Internal Server Error
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                title: Service Unavailable
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: SEARCH
                    title: Service unavailable
                    details: Temporarily unable to handle the request, try again later
                description: Service Unavailable
      parameters:
      - required: false
        name: company_id
        in: query
        description: Company which owns the given search_id. If not specified your default company is used.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneTimeExportRequest'
        description: One-time export object to create.
      operationId: create_onetime_export
      description: ''
    get:
      tags:
      - Listening Exports
      summary: Get a list of all your one-time exports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneTimeExportListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                title: Bad Request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: Invalid data
                    details: Invalid JSON payload
                description: Bad Request
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                title: Unauthorized request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: AUTH
                    title: Unauthorized
                    details: Invalid or expired authorization header
                description: Unauthorized request
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                type: object
                title: Permission denied
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: ENTITLEMENT
                    title: Entitlement missing
                    details: 'You are missing required entitlements, in order to access given content: ["news", "social"]. Please contact your sales representative to add the necessary entitlement to your Meltwater account.'
                description: Permission denied
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                title: Not Found
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: EXPORT
                    title: Unknown resource
                    details: The resource id you provided (1234) is unknown
                description: Not Found
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                title: Unprocessable entity
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: 'Validation error for field: window_size'
                    details: is not a valid integer
                description: Unprocessable entity
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                title: Internal Server Error
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: INTERNAL
                    title: Internal Server error
                    details: Something went wrong behind the scenes...
                description: Internal Server Error
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                title: Service Unavailable
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: SEARCH
                    title: Service unavailable
                    details: Temporarily unable to handle the request, try again later
                description: Service Unavailable
      operationId: list_onetime_exports
      description: ''
  /v3/exports/one-time/{id}:
    get:
      tags:
      - Listening Exports
      summary: Get details of a one-time export
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneTimeExportResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                title: Bad Request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: Invalid data
                    details: Invalid JSON payload
                description: Bad Request
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                title: Unauthorized request
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: AUTH
                    title: Unauthorized
                    details: Invalid or expired authorization header
                description: Unauthorized request
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                type: object
                title: Permission denied
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: ENTITLEMENT
                    title: Entitlement missing
                    details: 'You are missing required entitlements, in order to access given content: ["news", "social"]. Please contact your sales representative to add the necessary entitlement to your Meltwater account.'
                description: Permission denied
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                title: Not Found
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: EXPORT
                    title: Unknown resource
                    details: The resource id you provided (1234) is unknown
                description: Not Found
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                title: Unprocessable entity
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: VALIDATION
                    title: 'Validation error for field: window_size'
                    details: is not a valid integer
                description: Unprocessable entity
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                title: Internal Server Error
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: INTERNAL
                    title: Internal Server error
                    details: Something went wrong behind the scenes...
                description: Internal Server Error
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                title: Service Unavailable
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - type
                      - details
                      - title
                      properties:
                        type:
                          type: string
                          example: VALIDATION
                          description: Category of error
                        title:
                          type: string
                          example: 'Validation error for field: type'
                          description: Title of error
                        details:
                          type: string
                          example: This field cannot be updated
                          description: Details about the error
                      additionalProperties: false
                    description: List of problems with the request
                example:
                  errors:
                  - type: SEARCH
                    title: Service unavailable
                    details: Temporarily unable to handle the request, try again later
                description: Service Unavailable
      parameters:
      - required: true
        name: id
        in: path
        description: One-time export id
        example: 123
        schema:
          type: integer
      operationId: show_onetime_export
      description: ''
    delete:
      tags:
      - Listening Exports
      summar

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/meltwater/refs/heads/main/openapi/meltwater-listening-exports-api-openapi.yml