Meltwater · Schema
Meltwater API Schemas
JSON Schema definitions extracted from the Meltwater API OpenAPI specification
Media MonitoringSocial ListeningPR AnalyticsBrand IntelligenceNews APISocial AnalyticsMedia Intelligence
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Meltwater API Schemas",
"description": "JSON Schema definitions extracted from the Meltwater API OpenAPI specification",
"definitions": {
"DocModTag": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"DocumentTagsPayload": {
"type": "object",
"required": [
"document_ids",
"tags"
],
"properties": {
"document_ids": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/DocModTag"
}
}
}
},
"MWAPIError": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MWAPIErrorDetails"
}
}
}
},
"RateLimitedError": {
"description": "RateLimitedError",
"example": {
"message": "Service Overloaded",
"errors": {}
},
"allOf": [
{
"$ref": "#/components/schemas/Errors"
},
{
"required": [
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"description": "RateLimitedError"
}
]
},
"SingleSearchRequest": {
"required": [
"search"
],
"type": "object",
"properties": {
"search": {
"$ref": "#/components/schemas/SearchRequestV2"
}
},
"title": "Search Resource",
"description": "Search Resource",
"additionalProperties": false
},
"SearchRequestV2": {
"required": [
"name",
"query"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name associated with this search",
"example": "Electric cars"
},
"query": {
"$ref": "#/components/schemas/Query"
},
"id": {
"type": "integer",
"example": 1024,
"description": "Identifier"
}
},
"title": "Search",
"example": {
"query": {
"type": "boolean",
"filter_set": null,
"case_sensitivity": false,
"boolean": "Tesla OR (Volvo NEAR electric)"
},
"name": "Electric cars"
},
"description": "Search",
"additionalProperties": false
},
"Query": {
"description": "Query associated with a search",
"oneOf": [
{
"$ref": "#/components/schemas/BooleanQuery"
},
{
"$ref": "#/components/schemas/KeywordQuery"
},
{
"$ref": "#/components/schemas/CombinedQuery"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"boolean": "#/components/schemas/BooleanQuery",
"keyword": "#/components/schemas/KeywordQuery",
"combined": "#/components/schemas/CombinedQuery"
}
}
},
"BooleanQuery": {
"required": [
"case_sensitivity",
"boolean"
],
"type": "object",
"properties": {
"filter_set": {
"$ref": "#/components/schemas/FilterSet"
},
"case_sensitivity": {
"type": "string",
"description": "The case sensitivity for this query",
"enum": [
"yes",
"no",
"hybrid"
]
},
"boolean": {
"type": "string",
"description": "The boolean query string"
}
}
},
"FilterSet": {
"description": "The optional Filter Set to apply to this search",
"oneOf": [
{
"$ref": "#/components/schemas/SavedFilterSet"
},
{
"$ref": "#/components/schemas/EmbeddedFilterSet"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"saved": "#/components/schemas/SavedFilterSet",
"embedded": "#/components/schemas/EmbeddedFilterSet"
}
}
},
"SavedFilterSet": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID number for the Saved Filter Set",
"format": "int64"
},
"name": {
"type": "string",
"description": "Name of the Saved Filter Set, is optional when referencing one"
},
"subtype": {
"type": "string",
"description": "Type of Saved Filter Set, may be CUSTOM for user-created or QUICKPICK for meltwater-created, is optional when referencing one",
"enum": [
"custom",
"quickpick"
]
}
}
},
"EmbeddedFilterSet": {
"type": "object"
},
"KeywordQuery": {
"required": [
"case_sensitivity"
],
"type": "object",
"properties": {
"filter_set": {
"$ref": "#/components/schemas/FilterSet"
},
"case_sensitivity": {
"type": "string",
"description": "The case sensitivity for this query",
"enum": [
"yes",
"no",
"hybrid"
]
},
"not_keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "None of these keywords should match"
},
"any_keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "At least one of these keywords must match"
},
"all_keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "All of these keywords must match"
}
}
},
"CombinedQuery": {
"type": "object",
"properties": {
"filter_set": {
"$ref": "#/components/schemas/FilterSet"
},
"not_searches": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "None of these searches should match"
},
"any_searches": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "At least one of these searches must match"
},
"all_searches": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "All of these searches must match"
}
}
},
"Errors": {
"required": [
"type"
],
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetails"
},
"description": "List of problems with the request"
},
"type": {
"type": "string",
"enum": [
"NotFound",
"ServiceUnavailable",
"Unauthorized",
"ValidationFailed"
]
}
},
"description": "Errors",
"discriminator": {
"propertyName": "type"
}
},
"ErrorDetails": {
"required": [
"type",
"title",
"details"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Category of error"
},
"title": {
"type": "string",
"description": "Title of error"
},
"details": {
"type": "string",
"description": "Details about the error"
}
}
},
"SingleSearch": {
"required": [
"search"
],
"type": "object",
"properties": {
"search": {
"$ref": "#/components/schemas/SearchV2"
}
},
"title": "Search Resource",
"description": "Search Resource",
"additionalProperties": false
},
"SearchV2": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"updated": {
"type": "string",
"format": "date-time",
"example": "2020-08-23T08:25:56.000Z",
"description": "UTC date time (in ISO-8601 format) when the search was last updated"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1024,
"description": "Identifier"
},
"name": {
"type": "string",
"example": "Electric cars",
"description": "Search name"
},
"query": {
"$ref": "#/components/schemas/Query"
}
},
"title": "Search",
"example": {
"updated": "2020-08-23T08:25:56.000Z",
"query": {
"type": "boolean",
"filter_set": null,
"case_sensitivity": false,
"boolean": "Tesla OR (Volvo NEAR electric)"
},
"name": "Electric cars",
"id": 1999
},
"description": "Search",
"additionalProperties": false
},
"Unit": {
"type": "object"
},
"SearchListResponse": {
"type": "object",
"properties": {
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchV2"
}
}
},
"title": "Search List Response",
"required": [
"searches"
],
"description": "Search List Response",
"additionalProperties": false
},
"CompanyList": {
"type": "object",
"properties": {
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Company"
}
}
},
"title": "Company List",
"items": {
"$ref": "#/components/schemas/Company"
},
"description": "Company List"
},
"Company": {
"required": [
"name",
"id"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Company name",
"example": "Meltwater"
},
"id": {
"type": "string",
"description": "Company unique identifier",
"example": "61d07a1eb6b501051b5af3d7"
}
},
"title": "Company",
"example": {
"name": "Meltwater",
"id": "61d07a1eb6b501051b5af3d7"
},
"description": "Company",
"additionalProperties": false
},
"WorkspaceList": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"workspaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workspace"
}
}
},
"title": "Workspace List",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"description": "Workspace List"
},
"Workspace": {
"required": [
"id",
"name",
"description",
"created_at"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Workspace name",
"example": "My Workspace"
},
"id": {
"type": "string",
"description": "Unique workspace identifier",
"example": "61d07a1eb6b501051b5af3d7"
},
"description": {
"type": "string",
"description": "Workspace description",
"example": "This is a super cool workspace"
},
"created_at": {
"title": "An ISO8601 date-time.",
"type": "string",
"description": "An ISO8601 date-time, including timezone offset.\n\nThe timezone offset is an offset in minutes from UTC.",
"format": "date-time"
}
},
"title": "Workspace",
"example": {
"name": "My Workspace",
"id": "61d07a1eb6b501051b5af3d7"
},
"description": "Company",
"additionalProperties": false
},
"TokenList": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Token"
}
}
},
"title": "Token List",
"description": "Token List"
},
"Token": {
"required": [
"id",
"label",
"created_at",
"created_by"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique token identifier",
"example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"label": {
"type": "string",
"description": "Token label",
"example": "My API Token"
},
"created_at": {
"title": "An ISO8601 date-time.",
"type": "string",
"description": "An ISO8601 date-time, including timezone offset.\n\nThe timezone offset is an offset in minutes from UTC.",
"format": "date-time"
},
"created_by": {
"type": "string",
"description": "Name of the user who created the token",
"example": "Alex Morgan"
}
},
"title": "Token",
"example": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"label": "My API Token",
"created_at": "2024-01-15T10:30:00Z",
"created_by": "Alex Morgan"
},
"description": "Token",
"additionalProperties": false
},
"TagList": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
},
"title": "Tag List",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": "Tag List"
},
"Tag": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Tag id",
"example": 12345
},
"name": {
"type": "string",
"description": "Tag name",
"example": "My Custom Tag"
}
},
"title": "Tag",
"example": {
"id": 12345,
"name": "My Custom Tag"
},
"description": "Tag",
"additionalProperties": false
},
"SearchCountResponse": {
"required": [
"count"
],
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Count"
}
},
"title": "Search Count",
"description": "Number of results for the search",
"additionalProperties": false
},
"Count": {
"required": [
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total count",
"format": "int64",
"example": 901382
}
},
"description": "Number of results for the search",
"title": "Count",
"additionalProperties": false
},
"FilterSetList": {
"type": "object",
"properties": {
"filter_sets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterSet"
}
}
}
},
"CustomCategoriesList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total count",
"format": "int64",
"example": 12
},
"custom_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomCategory"
}
}
}
},
"CustomCategory": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Custom category id",
"format": "int64",
"example": 11234
},
"name": {
"type": "string",
"description": "Name of the custom category",
"example": "My Custom Category"
},
"type": {
"type": "string",
"description": "Type of the category, can be `include` or `exclude`",
"example": "include"
}
}
},
"ValidationFailed": {
"required": [
"errors",
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A message describing, in brief, the problem."
},
"errors": {
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"description": "A description of the problem encountered on this field."
}
},
"description": "A breakdown of each problem encountered, by field."
}
},
"example": {
"message": "Validation Failed",
"errors": {
"start": [
"'foo' is not a valid ISO 8601 local timestamp"
],
"end": [
"Missing required parameter"
]
}
}
},
"SummaryResponse": {
"required": [
"sentiment",
"time_series",
"top_countries",
"top_languages",
"unique_authors",
"volume"
],
"type": "object",
"properties": {
"unique_authors": {
"type": "integer",
"format": "int64"
},
"top_countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryStats"
}
},
"sentiment": {
"$ref": "#/components/schemas/Sentiments"
},
"top_languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageStats"
}
},
"time_series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Day"
}
},
"volume": {
"$ref": "#/components/schemas/Volume"
}
},
"description": "SummaryResponse"
},
"Volume": {
"required": [
"document_count"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"per_day": {
"type": "integer",
"format": "int64"
},
"per_hour": {
"type": "integer",
"format": "int64"
}
},
"description": "Volume"
},
"CountryStats": {
"required": [
"country_code",
"document_count",
"percentage"
],
"type": "object",
"properties": {
"country_code": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "CountryStats"
},
"TopSharedResponse": {
"required": [
"document_count",
"results"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
},
"description": "TopSharedResponse"
},
"Twitter": {
"type": "object",
"properties": {
"followers": {
"type": "integer",
"format": "int64"
},
"following": {
"type": "integer",
"format": "int64"
},
"external_id": {
"type": "string"
}
},
"description": "Twitter"
},
"NotFound": {
"required": [
"errors",
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A message describing, in brief, the problem."
},
"errors": {
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"description": "A description of the problem encountered on this field."
}
},
"description": "A breakdown of each problem encountered, by field."
}
},
"example": {
"message": "Not Found",
"errors": {
":searchId": [
"A Saved Search with that ID could not be found"
]
}
}
},
"SentimentStats": {
"required": [
"document_count",
"percentage"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "SentimentStats"
},
"Entity": {
"required": [
"document_count",
"entity",
"type",
"percentage"
],
"type": "object",
"properties": {
"entity": {
"type": "string"
},
"type": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Entity"
},
"Day": {
"required": [
"date",
"document_count",
"hours"
],
"type": "object",
"properties": {
"date": {
"title": "An ISO8601 date, excluding time and timezone/offset.",
"type": "string",
"description": "An ISO8601 date, excluding time and timezone/offset.\n\nThe year, month and day formatted according to ISO8601. The date\nrepresents the local date at the timezone given in the `tz` parameter.",
"format": "date"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"hours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Hour"
}
}
},
"description": "Day"
},
"LanguageStats": {
"required": [
"document_count",
"language_code",
"percentage"
],
"type": "object",
"properties": {
"language_code": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "LanguageStats"
},
"AnalyticsTag": {
"required": [
"document_count",
"percentage",
"tag"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Tag"
},
"AnalyticsServiceUnavailable": {
"description": "ServiceUnavailable",
"example": {
"message": "Service Unavailable",
"errors": {}
},
"allOf": [
{
"$ref": "#/components/schemas/Errors"
},
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"description": "ServiceUnavailable"
}
]
},
"Hour": {
"required": [
"document_count",
"timestamp"
],
"type": "object",
"properties": {
"timestamp": {
"title": "An ISO8601 date-time.",
"type": "string",
"description": "An ISO8601 date-time, including timezone offset.\n\nThe timezone offset is an offset in minutes from UTC.",
"format": "date-time"
},
"document_count": {
"type": "integer",
"format": "int64"
}
},
"description": "Hour"
},
"Result": {
"required": [
"author",
"document_count"
],
"type": "object",
"properties": {
"author": {
"$ref": "#/components/schemas/Author"
},
"document_count": {
"type": "integer",
"format": "int64"
}
},
"description": "Result"
},
"Document": {
"required": [
"author",
"shares"
],
"type": "object",
"properties": {
"author": {
"$ref": "#/components/schemas/Author"
},
"url": {
"type": "string"
},
"country_code": {
"type": "string"
},
"shares": {
"$ref": "#/components/schemas/Shares"
},
"language_code": {
"type": "string"
},
"external_id": {
"type": "string"
},
"created_at": {
"title": "An ISO8601 date-time.",
"type": "string",
"description": "An ISO8601 date-time, including timezone offset.\n\nThe timezone offset is an offset in minutes from UTC.",
"format": "date-time"
}
},
"description": "Document"
},
"Author": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"display_name": {
"type": "string"
},
"twitter": {
"$ref": "#/components/schemas/Twitter"
},
"avatar_url": {
"type": "string"
},
"authority": {
"type": "integer",
"format": "int64"
}
},
"description": "Author"
},
"Shares": {
"type": "object",
"properties": {
"retweets": {
"type": "integer",
"format": "int64"
},
"likes": {
"type": "integer",
"format": "int64"
}
},
"description": "Shares"
},
"Keyphrase": {
"required": [
"document_count",
"keyphrase",
"percentage"
],
"type": "object",
"properties": {
"keyphrase": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Keyphrase"
},
"Link": {
"required": [
"document_count",
"link",
"percentage"
],
"type": "object",
"properties": {
"link": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Link"
},
"Mention": {
"required": [
"document_count",
"mention",
"percentage"
],
"type": "object",
"properties": {
"mention": {
"type": "string"
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Mention"
},
"Topic": {
"required": [
"document_count",
"topic",
"sub_topics",
"percentage"
],
"type": "object",
"properties": {
"topic": {
"type": "string"
},
"sub_topics": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Topic"
}
},
"document_count": {
"type": "integer",
"format": "int64"
},
"percentage": {
"type": "number",
"format": "double"
}
},
"description": "Topic"
},
"TopTagsResponse": {
"required": [
"document_count",
"tags"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnalyticsTag"
}
}
},
"description": "TopTagsResponse"
},
"TopMentionsResponse": {
"required": [
"document_count",
"tags"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mention"
}
}
},
"description": "TopMentionsResponse"
},
"TopTopicsResponse": {
"required": [
"document_count",
"topics"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Topic"
}
}
},
"description": "TopTopicsResponse"
},
"TopSharedLinksResponse": {
"required": [
"document_count",
"links"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
},
"description": "TopKeyphrasesResponse"
},
"TopKeyphrasesResponse": {
"required": [
"document_count",
"keyphrases"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"keyphrases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Keyphrase"
}
}
},
"description": "TopKeyphrasesResponse"
},
"Unauthorized": {
"required": [
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A message describing, in brief, the problem."
}
},
"example": {
"message": "Unauthorized"
}
},
"Sentiments": {
"required": [
"negative",
"neutral",
"positive",
"unknown"
],
"type": "object",
"properties": {
"positive": {
"$ref": "#/components/schemas/SentimentStats"
},
"negative": {
"$ref": "#/components/schemas/SentimentStats"
},
"neutral": {
"$ref": "#/components/schemas/SentimentStats"
},
"unknown": {
"$ref": "#/components/schemas/SentimentStats"
}
},
"description": "Sentiments"
},
"TopEntitiesResponse": {
"required": [
"document_count",
"entities"
],
"type": "object",
"properties": {
"document_count": {
"type": "integer",
"format": "int64"
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Entity"
}
}
},
"description": "TopEntitiesResponse"
},
"TopSourcesResponse": {
"required": [
"d
# --- truncated at 32 KB (143 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/meltwater/refs/heads/main/json-schema/meltwater-schemas.json