Meltwater Explore+ Assets API

Manage your Explore+ assets including searches and custom fields.

OpenAPI Specification

meltwater-explore-assets-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Meltwater Account Management Explore+ Assets 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: Explore+ Assets
  description: Manage your Explore+ assets including searches and custom fields.
  parent: Explore+
paths:
  /v3/explore_plus/assets/custom_fields:
    get:
      tags:
      - Explore+ Assets
      summary: List all custom fields.
      description: List all custom fields.
      parameters:
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          default: 1
      - name: page_size
        in: query
        description: 'The number of custom fields to return per request. Min: 1, Max: 100'
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 10
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields.MultiCustomFieldsResponse'
              examples:
                List Custom Fields:
                  summary: List Custom Fields
                  value:
                    page: 1
                    page_size: 10
                    total: 2
                    custom_fields:
                    - id: 1234
                      folder_id: 12
                      name: My Custom Field
                      description: my first custom field
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: multi_value
                    - id: 5678
                      folder_id: null
                      name: My Custom Field Tag
                      description: my second custom field
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: tag
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    post:
      tags:
      - Explore+ Assets
      summary: Create a new custom field.
      description: Create a new custom field.
      parameters:
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Custom Field
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_fields.CreateCustomFieldRequestInput'
            examples:
              Create Tag Custom Field:
                summary: Create a Custom Field Tag
                value:
                  custom_field:
                    name: My Custom Field
                    description: my new custom field
                    type: tag
              Create Multi-Value Custom Field:
                summary: Create a Multi-Value Custom Field
                value:
                  custom_field:
                    name: My Custom Field
                    description: my new custom field
                    folder_id: 123
                    type: multi_value
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields.SingleCustomFieldResponse'
              examples:
                Create Tag Custom Field:
                  summary: Create a Custom Field Tag
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: null
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: tag
                      values:
                      - id: 456
                        name: my custom field value
                        color: '#FFFFFF'
                        created: '2025-01-01T00:00:00Z'
                        updated: '2025-01-01T00:00:00Z'
                        num_rules: 0
                Create Multi-Value Custom Field:
                  summary: Create a Multi-Value Custom Field
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: 123
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: multi_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
  /v3/explore_plus/assets/custom_fields/{custom_field_id}:
    get:
      tags:
      - Explore+ Assets
      summary: Fetch a given custom field.
      description: Fetch a given custom field.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields.SingleCustomFieldResponse'
              examples:
                Get Tag Custom Field:
                  summary: Get a Custom Field Tag
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: null
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: tag
                      values:
                      - id: 456
                        name: my custom field value
                        color: '#FFFFFF'
                        created: '2025-01-01T00:00:00Z'
                        updated: '2025-01-01T00:00:00Z'
                        num_rules: 0
                Get Multi-Value Custom Field:
                  summary: Get a Multi-Value Custom Field
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: 123
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: multi_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    put:
      tags:
      - Explore+ Assets
      summary: Update a given custom field.
      description: Update a given custom field.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Custom Field
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_fields.UpdateCustomFieldRequestInput'
            examples:
              Update Tag Custom Field:
                summary: Update a Custom Field Tag
                value:
                  custom_field:
                    name: My Custom Field
                    description: my new custom field
                    type: tag
              Update Multi-Value Custom Field:
                summary: Update a Multi-Value Custom Field
                value:
                  custom_field:
                    name: My Custom Field
                    description: my new custom field
                    folder_id: 123
                    type: multi_value
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields.SingleCustomFieldResponse'
              examples:
                Update Tag Custom Field:
                  summary: Update a Custom Field Tag
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: null
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: tag
                      values:
                      - id: 456
                        name: my custom field value
                        color: '#FFFFFF'
                        created: '2025-01-01T00:00:00Z'
                        updated: '2025-01-01T00:00:00Z'
                        num_rules: 0
                Update Multi-Value Custom Field:
                  summary: Update a Multi-Value Custom Field
                  value:
                    custom_field:
                      name: My Custom Field
                      description: my new custom field
                      folder_id: 123
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      type: multi_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    delete:
      tags:
      - Explore+ Assets
      summary: Delete a given custom field.
      description: Delete a given custom field.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
  /v3/explore_plus/assets/custom_fields/{custom_field_id}/values:
    post:
      tags:
      - Explore+ Assets
      summary: Create a new custom field value.
      description: Create a new custom field value.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Custom Field Value
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_field_values.CreateCustomFieldValueRequestInput'
            examples:
              Create Custom Field Value:
                summary: Create a Custom Field Value
                value:
                  custom_field_value:
                    name: My Custom Field Value
                    color: '#FFFFFF'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_field_values.SingleCustomFieldValueResponse'
              examples:
                Create Custom Field Value:
                  summary: Create a Custom Field Value
                  value:
                    custom_field_value:
                      id: 123
                      name: My Custom Field Value
                      color: '#FFFFFF'
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
  /v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}:
    get:
      tags:
      - Explore+ Assets
      summary: Fetch a given custom field value.
      description: Fetch a given custom field value.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_field_values.SingleCustomFieldValueResponse'
              examples:
                Get Custom Field Value:
                  summary: Get a Custom Field Value
                  value:
                    custom_field_value:
                      id: 123
                      name: My Custom Field Value
                      color: '#FFFFFF'
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      rules:
                      - id: 456
                        created: '2025-01-01T00:00:00Z'
                        updated: '2025-01-01T00:00:00Z'
                        query:
                          case_sensitivity: 'no'
                          all_keywords:
                          - honda
                          any_keywords:
                          - mazda
                          not_keywords:
                          - nissan
                          type: keyword
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    put:
      tags:
      - Explore+ Assets
      summary: Update a given custom field value.
      description: Update a given custom field value.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Custom Field Value
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_field_values.CreateCustomFieldValueRequestInput'
            examples:
              Update Custom Field Value:
                summary: Update a Custom Field Value
                value:
                  custom_field_value:
                    name: My Custom Field Value
                    color: '#FFFFFF'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_field_values.SingleCustomFieldValueResponse'
              examples:
                Update Custom Field Value:
                  summary: Update a Custom Field Value
                  value:
                    custom_field_value:
                      id: 123
                      name: My Custom Field Value
                      color: '#FFFFFF'
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      rules:
                      - id: 456
                        created: '2025-01-01T00:00:00Z'
                        updated: '2025-01-01T00:00:00Z'
                        query:
                          case_sensitivity: 'no'
                          all_keywords:
                          - honda
                          any_keywords:
                          - mazda
                          not_keywords:
                          - nissan
                          type: keyword
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    delete:
      tags:
      - Explore+ Assets
      summary: Delete a given custom field value.
      description: Delete a given custom field value.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
  /v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules:
    post:
      tags:
      - Explore+ Assets
      summary: Create a new assignment rule.
      description: Create a new assignment rule.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Assignment Rule
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/assignment_rules.CreateAssignmentRuleRequestInput'
            examples:
              Create Boolean Assignment Rule:
                summary: Create a Boolean Assignment Rule
                value:
                  rule:
                    query:
                      case_sensitivity: 'no'
                      boolean: honda OR mazda
                      type: boolean
              Create Keyword Assignment Rule:
                summary: Create a Keyword Assignment Rule
                value:
                  rule:
                    query:
                      case_sensitivity: 'no'
                      all_keywords:
                      - honda
                      any_keywords:
                      - mazda
                      not_keywords:
                      - nissan
                      type: keyword
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/assignment_rules.SingleAssignmentRuleResponse'
              examples:
                Create Boolean Assignment Rule:
                  summary: Create a Boolean Assignment Rule
                  value:
                    rule:
                      id: 456
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      query:
                        case_sensitivity: 'no'
                        boolean: honda OR mazda
                        type: boolean
                Create Keyword Assignment Rule:
                  summary: Create a Keyword Assignment Rule
                  value:
                    rule:
                      id: 456
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      query:
                        case_sensitivity: 'no'
                        all_keywords:
                        - honda
                        any_keywords:
                        - mazda
                        not_keywords:
                        - nissan
                        type: keyword
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
  /v3/explore_plus/assets/custom_fields/{custom_field_id}/values/{value_id}/rules/{rule_id}:
    get:
      tags:
      - Explore+ Assets
      summary: Fetch a given assignment rule.
      description: Fetch a given assignment rule.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: rule_id
        in: path
        description: Assignment Rule ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/assignment_rules.SingleAssignmentRuleResponse'
              examples:
                Get Boolean Assignment Rule:
                  summary: Get a Boolean Assignment Rule
                  value:
                    rule:
                      id: 456
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      query:
                        case_sensitivity: 'no'
                        boolean: honda OR mazda
                        type: boolean
                Get Keyword Assignment Rule:
                  summary: Get a Keyword Assignment Rule
                  value:
                    rule:
                      id: 456
                      created: '2025-01-01T00:00:00Z'
                      updated: '2025-01-01T00:00:00Z'
                      query:
                        case_sensitivity: 'no'
                        all_keywords:
                        - honda
                        any_keywords:
                        - mazda
                        not_keywords:
                        - nissan
                        type: keyword
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ExplorePlusAPIError'
      security:
      - apikey: []
    put:
      tags:
      - Explore+ Assets
      summary: Update a given assignment rule.
      description: Update a given assignment rule.
      parameters:
      - name: custom_field_id
        in: path
        description: Custom Field ID
        required: true
        schema:
          type: integer
      - name: value_id
        in: path
        description: Custom Field Value ID
        required: true
        schema:
          type: integer
      - name: rule_id
        in: path
        description: Assignment Rule ID
        required: true
        schema:
          type: integer
      - name: workspace_id
        in: query
        description: Set the workspace to search by. If accessing the company space, set to `none`
        required: true
        schema:
          type: string
      - name: company_id
        in: query
        description: Set the company to search by
        schema:
          type: string
      requestBody:
        description: Assignment Rule
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/assignment_rules.CreateAssignmentRuleRequestInput'
            examples:
              Update Boolean Assignment Rule:
                summary: Update a Boolean Assignment Rule
                value:
                  rule:
                    query:
                      case_sensitivity: 'no'
                      boolean: honda OR mazda
                      type: boolean
              Update Keyword Assignment Rule:
                summary: Update a Keyword Assignment Rule
                value:
                  rule:
                    query:
                      case_sensitivity: 'no'
                      all_keywords:
                      - honda
                      any_keywords:
                      - mazda
             

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