Meltwater

App · 20 actions

Manage Meltwater saved searches and tags; search mentions; inspect exports, account metadata and usage; watch searches and tags.

Actions

ActionWhat it does
Add document tagsAdd document tags.
Count mentionsCount mentions.
Create searchCreate search.
Create tagCreate tag.
Delete searchDelete search.
Delete tagDelete tag.
Get exportGet export.
Get searchGet search.
Get usageGet usage.
List companiesList companies.
List custom categoriesList custom categories.
List exportsList exports.
List filter setsList filter sets.
List hooksList hooks.
List searchesList searches.
List tagsList tags.
List workspacesList workspaces.
Remove document tagsRemove document tags.
Search mentionsSearch mentions.
Update searchUpdate search.

Add document tags

Add document tags.

Inputs

Company IDcompany_idtext
Set the company where the change will be applied
Document IDsdocument_idslistRequired
Document IDs.
Tagstag_idslistRequired
Tags.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": "example"
  }
}

Count mentions

Count mentions.

Inputs

IdidnumberRequired
Search id
Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.
Start datestart_datedate and time
The start date of the search to count result for. Default: `two weeks ago` in ISO8601 format. Must include a timezone offset, for example `2024-04-01T00:00:00Z`.
End dateend_datedate and time
The end date of the search to count result for. Default: `now` in ISO8601 format. Must include a timezone offset, for example `2024-04-30T23:59:59Z`.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "count": {
      "total": 901382
    }
  }
}

Create search.

Inputs

Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.
NamenametextRequired
The name associated with this search
QueryqueryobjectRequired
Query associated with a search
Ididnumber
Identifier

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "search": {
      "id": 1025,
      "name": "Electric Cars",
      "query": {
        "boolean": "cars AND electric",
        "case_sensitivity": false,
        "filter_set": null
      },
      "updated": "2020-08-23T08:25:56Z"
    }
  }
}

Create tag

Create tag.

Inputs

Company IDcompany_idtext
Company which will own the new tag. If not specified, your default company is used.
NamenametextRequired
Name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "tag": {
      "id": 123,
      "name": "new-tag"
    }
  }
}

Delete search.

Inputs

IdidnumberRequired
Search id
Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete tag

Delete tag.

Inputs

Tagtag_idnumberRequired
Tag ID
Company IDcompany_idtext
Company which owns the tag to be deleted. If not specified, your default company is used.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get export

Get export.

Inputs

IdidnumberRequired
One-time export id

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "onetime_export": {
      "company_name": "example",
      "end_date": "2020-03-29T23:59:59.000000Z",
      "id": 1,
      "searches": [],
      "start_date": "2020-03-25T00:00:00.000000Z"
    }
  }
}

Get search.

Inputs

IdidnumberRequired
Search id
Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.
Expand combinedexpand_combinedtrue/false
For combined searches, show whether the ids belongs to a search, filter set or custom category

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "search": {
      "id": 1024,
      "name": "Electric Cars",
      "query": {
        "boolean": "Tesla OR (Volvo NEAR electric)",
        "case_sensitivity": "no",
        "filter_set": null,
        "type": "boolean"
      },
      "updated": "2020-08-23T08:25:56Z"
    }
  }
}

Get usage

Get usage.

Inputs

Token IDtoken_idtext
Optional API token ID to filter usage
Periodperiodtext
The time period for this statistics queryOne of: 24hours, 7days, 30days, 12months.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List companies

List companies.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "companies": [
      {
        "id": "61d07a1eb6b501051b5af3d7",
        "name": "Meltwater"
      }
    ]
  }
}

List custom categories

List custom categories.

Inputs

Company IDcompany_idtext
Company which owns the given custom categories. If not specified your default company is used.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "count": 2,
    "custom_categories": [
      {
        "id": 123,
        "name": "Japanese cars",
        "type": "include"
      },
      {
        "id": 456,
        "name": "German cars",
        "type": "exclude"
      }
    ]
  }
}

List exports

List exports.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "onetime_exports": []
  }
}

List filter sets

List filter sets.

Inputs

Company IDcompany_idtext
Company which owns the given filter sets. If not specified your default company is used.
Include quickpicksinclude_quickpickstrue/false
Include meltwater-provided QUICKPICK filter sets, default "false"

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "filter_sets": [
      {
        "id": 123,
        "name": "English and from the UK",
        "subtype": "custom",
        "type": "saved"
      },
      {
        "id": 456,
        "name": "Well known french journalists",
        "subtype": "quickpick",
        "type": "saved"
      }
    ]
  }
}

List hooks

List hooks.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List searches

List searches.

Inputs

Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.
Query typequery_typetext
Only return searches of the specified query type, if omitted searches of all query types will be returnedOne of: boolean, keyword, combined.
Expand combinedexpand_combinedtrue/false
For combined searches, show whether the ids belongs to a search, filter set or custom category

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "searches": [
      {
        "id": 1025,
        "name": "Electric Cars",
        "updated": "2020-08-23T08:25:56Z"
      },
      {
        "id": 1027,
        "name": "Pokemon",
        "updated": "2020-08-23T08:25:56Z"
      }
    ]
  }
}

List tags

List tags.

Inputs

Company IDcompany_idtext
Company which owns the given tags. If not specified your default company is used.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "tags": [
      {
        "id": 123456,
        "name": "my tag"
      }
    ]
  }
}

List workspaces

List workspaces.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "count": 0,
    "workspaces": [
      {
        "created_at": "2023-09-19T14:54:38Z",
        "description": "My awesome workspace",
        "id": "61d07a1eb6b501051b5af3d7",
        "name": "My Workspace"
      }
    ]
  }
}

Remove document tags

Remove document tags.

Inputs

Company IDcompany_idtext
Set the company where the change will be applied
Document IDsdocument_idslistRequired
Document IDs.
Tagstag_idslistRequired
Tags.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": "example"
  }
}

Search mentions

Search mentions.

Inputs

IdidnumberRequired
Search ID
Company IDcompany_idtext
Set the company to search by
Countriescountrieslist
Countries.
Endenddate and time
End.
Languageslanguageslist
Languages.
Pagepagenumber
Page.At most 10.
Page sizepage_sizenumber
Page size.From 0 to 100.
Sentimentssentimentslist
Sentiments.
Sort bysort_bytext
Sort by.One of: date, country, sentiment, language, title, reach, relevance, engagement, social_echo (Social echo), prominence, views.
Sort ordersort_ordertext
Sort order.One of: asc, desc.
Sourcessourceslist
Sources.
Startstartdate and time
Start.
Templatetemplateobject
Template.
Keywordskeywordslist
List of keywords to filter documents by.
Emojisemojislist
List of emojis to filter documents by.
Custom categoriescustom_categorieslist
List of custom category IDs to filter documents by.
Filter setfilter_settext
ID of a filter set to apply.
Author listsauthor_listslist
List of author list IDs to filter documents by.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "tz": "Europe/London"
  }
}

Update search.

Inputs

IdidnumberRequired
Search id
Company IDcompany_idtext
Company which owns the given search. If not specified your default company is used.
Namenametext
The name associated with this search
Queryqueryobject
Query associated with a search

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "search": {
      "id": 1025,
      "name": "Electric Cars",
      "query": {
        "boolean": "cars AND electric",
        "case_sensitivity": false,
        "filter_set": null
      },
      "updated": "2020-08-23T08:25:56Z"
    }
  }
}

On this page