Meltwater
App · 20 actions
Manage Meltwater saved searches and tags; search mentions; inspect exports, account metadata and usage; watch searches and tags.
Actions
| Action | What it does |
|---|---|
| Add document tags | Add document tags. |
| Count mentions | Count mentions. |
| Create search | Create search. |
| Create tag | Create tag. |
| Delete search | Delete search. |
| Delete tag | Delete tag. |
| Get export | Get export. |
| Get search | Get search. |
| Get usage | Get usage. |
| List companies | List companies. |
| List custom categories | List custom categories. |
| List exports | List exports. |
| List filter sets | List filter sets. |
| List hooks | List hooks. |
| List searches | List searches. |
| List tags | List tags. |
| List workspaces | List workspaces. |
| Remove document tags | Remove document tags. |
| Search mentions | Search mentions. |
| Update search | Update search. |
Add document tags
Add document tags.
Inputs
- Company ID
company_idtext - Set the company where the change will be applied
- Document IDs
document_idslistRequired - Document IDs.
- Tags
tag_idslistRequired - Tags.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": "example"
}
}Count mentions
Count mentions.
Inputs
- Id
idnumberRequired - Search id
- Company ID
company_idtext - Company which owns the given search. If not specified your default company is used.
- Start date
start_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 date
end_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
Create search.
Inputs
- Company ID
company_idtext - Company which owns the given search. If not specified your default company is used.
- Name
nametextRequired - The name associated with this search
- Query
queryobjectRequired - Query associated with a search
- Id
idnumber - 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 ID
company_idtext - Company which will own the new tag. If not specified, your default company is used.
- Name
nametextRequired - Name.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"tag": {
"id": 123,
"name": "new-tag"
}
}
}Delete search
Delete search.
Inputs
- Id
idnumberRequired - Search id
- Company ID
company_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
- Tag
tag_idnumberRequired - Tag ID
- Company ID
company_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
- Id
idnumberRequired - 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
Get search.
Inputs
- Id
idnumberRequired - Search id
- Company ID
company_idtext - Company which owns the given search. If not specified your default company is used.
- Expand combined
expand_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 ID
token_idtext - Optional API token ID to filter usage
- Period
periodtext - 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 ID
company_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 ID
company_idtext - Company which owns the given filter sets. If not specified your default company is used.
- Include quickpicks
include_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 ID
company_idtext - Company which owns the given search. If not specified your default company is used.
- Query type
query_typetext - Only return searches of the specified query type, if omitted searches of all query types will be returnedOne of:
boolean,keyword,combined. - Expand combined
expand_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 ID
company_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 ID
company_idtext - Set the company where the change will be applied
- Document IDs
document_idslistRequired - Document IDs.
- Tags
tag_idslistRequired - Tags.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": "example"
}
}Search mentions
Search mentions.
Inputs
- Id
idnumberRequired - Search ID
- Company ID
company_idtext - Set the company to search by
- Countries
countrieslist - Countries.
- End
enddate and time - End.
- Languages
languageslist - Languages.
- Page
pagenumber - Page.At most 10.
- Page size
page_sizenumber - Page size.From 0 to 100.
- Sentiments
sentimentslist - Sentiments.
- Sort by
sort_bytext - Sort by.One of:
date,country,sentiment,language,title,reach,relevance,engagement,social_echo(Social echo),prominence,views. - Sort order
sort_ordertext - Sort order.One of:
asc,desc. - Sources
sourceslist - Sources.
- Start
startdate and time - Start.
- Template
templateobject - Template.
- Keywords
keywordslist - List of keywords to filter documents by.
- Emojis
emojislist - List of emojis to filter documents by.
- Custom categories
custom_categorieslist - List of custom category IDs to filter documents by.
- Filter set
filter_settext - ID of a filter set to apply.
- Author lists
author_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
Update search.
Inputs
- Id
idnumberRequired - Search id
- Company ID
company_idtext - Company which owns the given search. If not specified your default company is used.
- Name
nametext - The name associated with this search
- Query
queryobject - 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"
}
}
}