Meltwater · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Meltwater Listening Search Management API

14 actions 14 updates phrasing extends openapi/meltwater-listening-search-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Meltwater's API. It is a proposal applied on top of the contract, not a document Meltwater publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 14

$.info
$.paths['/v3/searches'].get
$.paths['/v3/searches'].post
$.paths['/v3/searches/{id}'].get
$.paths['/v3/searches/{id}'].put
$.paths['/v3/searches/{id}'].delete
$.paths['/v3/searches/{id}/count'].get
$.paths['/v3/tags'].get
$.paths['/v3/tags'].post
$.paths['/v3/tags/{tag_id}'].delete
$.paths['/v3/documents/add_tags'].post
$.paths['/v3/documents/remove_tags'].post
$.paths['/v3/filter_sets'].get
$.paths['/v3/custom_categories'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Meltwater Listening Search Management API
  version: 1.0.0
extends: openapi/meltwater-listening-search-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/v3/searches'].get
  update:
    x-apievangelist-phrasing:
      intent: List my saved searches
      effect: read
      questions:
      - Which saved searches do I have in Meltwater?
      - Can I list only searches of a certain query type?
      - How do I see the individual searches inside my combined searches?
      instructions:
      - text: List all my saved searches.
      - text: List my {query_type} searches.
        slots:
          query_type: query.query_type
      - text: List saved searches for company {company_id} with combined searches expanded ({expand_combined}).
        slots:
          company_id: query.company_id
          expand_combined: query.expand_combined
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved search
      effect: write
      questions:
      - How do I create a new saved search to monitor a brand?
      - Can I add a search under a specific company on my account?
      instructions:
      - text: Create a saved search with definition {search}.
        slots:
          search: requestBody.search
      - text: Add new search {search} for company {company_id}.
        slots:
          search: requestBody.search
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/searches/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved search's definition
      effect: read
      questions:
      - What query is behind a particular saved search?
      - How do I view the settings of one search by its ID?
      instructions:
      - text: Show saved search {id}.
        slots:
          id: path.id
      - text: Get the definition of search {id} with combined parts expanded ({expand_combined}).
        slots:
          id: path.id
          expand_combined: query.expand_combined
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/searches/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing saved search
      effect: write
      questions:
      - How do I change the keywords of a saved search I already have?
      - Can I edit an existing search without creating a new one?
      instructions:
      - text: Update saved search {id} to {search}.
        slots:
          id: path.id
          search: requestBody.search
      - text: Replace the definition of existing search {id} with {search} for company {company_id}.
        slots:
          id: path.id
          search: requestBody.search
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/searches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved search
      effect: destructive
      questions:
      - How do I remove a saved search I no longer use?
      - Is deleting a saved search permanent?
      instructions:
      - text: Delete saved search {id}.
        slots:
          id: path.id
      - text: Remove search {id} from company {company_id}.
        slots:
          id: path.id
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/searches/{id}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate how many results a search returns
      effect: read
      questions:
      - Roughly how many results does my saved search match in a given period?
      - Can I check a search's volume before I export it?
      instructions:
      - text: Get an approximate result count for search {id}.
        slots:
          id: path.id
      - text: Estimate how many results search {id} has between {start_date} and {end_date}.
        slots:
          id: path.id
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List my document tags
      effect: read
      questions:
      - What tags have been created for labelling documents?
      - Which tag names can I apply to documents for a given company?
      instructions:
      - text: List all my document tags.
      - text: Show the tags available for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new document tag
      effect: write
      questions:
      - How do I define a brand-new tag before labelling any documents with it?
      - Is there a length limit or uniqueness rule for new tag names?
      instructions:
      - text: Create a new tag {tag}.
        slots:
          tag: requestBody.tag
      - text: Define tag {tag} owned by company {company_id}.
        slots:
          tag: requestBody.tag
          company_id: query.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/tags/{tag_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag entirely
      effect: destructive
      questions:
      - What happens to tagged documents when I delete the tag itself?
      - Can I permanently get rid of a tag I no longer use?
      instructions:
      - text: Delete tag {tag_id} permanently.
        slots:
          tag_id: path.tag_id
      - text: Remove tag {tag_id} from company {company_id} altogether.
        slots:
          tag_id: path.tag_id
          company_id: query.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/documents/add_tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to documents
      effect: write
      questions:
      - How do I label a batch of documents with tags?
      - Is tagging documents applied immediately or asynchronously?
      instructions:
      - text: Add tags {tags} to documents {document_ids}.
        slots:
          tags: requestBody.tags
          document_ids: requestBody.document_ids
      - text: Tag documents {document_ids} with {tags} for company {company_id}.
        slots:
          document_ids: requestBody.document_ids
          tags: requestBody.tags
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/documents/remove_tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from documents
      effect: write
      questions:
      - How do I take a tag off documents I labelled by mistake?
      - Can I strip several tags from many documents at once?
      instructions:
      - text: Remove tags {tags} from documents {document_ids}.
        slots:
          tags: requestBody.tags
          document_ids: requestBody.document_ids
      - text: Untag documents {document_ids}, dropping {tags}, for company {company_id}.
        slots:
          document_ids: requestBody.document_ids
          tags: requestBody.tags
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/filter_sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List search filter sets
      effect: read
      questions:
      - Which filter sets can I apply to narrow my searches?
      - Can I include quickpick filters in the list of filter sets?
      instructions:
      - text: List all my search filter sets.
      - text: List filter sets including quickpicks ({include_quickpicks}).
        slots:
          include_quickpicks: query.include_quickpicks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/custom_categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List search custom categories
      effect: read
      questions:
      - What custom categories are defined for my searches?
      - Where can I see the custom categories set up for a company?
      instructions:
      - text: List all my search custom categories.
      - text: Show custom categories for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/meltwater-listening-search-management-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.