Meltwater API Reference
Public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefixes in their names.
Companies
All your companies
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | string | ID of the company |
name | string | Company name |
Example
CREATE VIEW meltwater_examples.example_Companies
AS
SELECT * FROM meltwater.Companies (
preview => TRUE
)DocumentsOneTimeExports
Documents for one-time export
Parameter
<export_id> (required): Export Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type |
|---|---|
report_date | date |
source_subregion | string |
source_reach_mobile | bigdecimal |
source_reach_desktop | bigdecimal |
source_reach | bigdecimal |
source_name | string |
source_information_type | string |
source_id | string |
source_country_code | string |
source_ave | bigdecimal |
metadata_tag_name | string |
metadata_search_name | string |
metadata_search_id | integer |
metadata_company_id | string |
document_visibility | string |
document_url | string |
document_title | string |
document_tags | string |
document_sentiment | string |
document_region | string |
document_publish_date | timestamp |
document_opening_text | string |
document_media_type | string |
document_location_approximate_region_name | string |
document_location_approximate_region_longitude | bigdecimal |
document_location_approximate_region_latitude | bigdecimal |
document_location_approximate_city_name | string |
document_location_approximate_city_longitude | bigdecimal |
document_location_approximate_city_latitude | bigdecimal |
document_language_code | string |
document_image_link | string |
document_id | string |
document_hit_sentence | string |
document_hidden | boolean |
document_city | string |
Example
CREATE VIEW meltwater_examples.example_DocumentsOneTimeExports
AS
SELECT * FROM meltwater.DocumentsOneTimeExports (
export_id => '4096441'
)DocumentsRecurringExports
Documents for recurring export
Parameter
<export_id> (required): Export Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type |
|---|---|
report_date | date |
source_subregion | string |
source_reach_mobile | bigdecimal |
source_reach_desktop | bigdecimal |
source_reach | bigdecimal |
source_name | string |
source_information_type | string |
source_id | string |
source_country_code | string |
source_ave | bigdecimal |
metadata_tag_name | string |
metadata_search_name | string |
metadata_search_id | integer |
metadata_company_id | string |
document_visibility | string |
document_url | string |
document_title | string |
document_tags | string |
document_sentiment | string |
document_region | string |
document_publish_date | timestamp |
document_opening_text | string |
document_media_type | string |
document_location_approximate_region_name | string |
document_location_approximate_region_longitude | bigdecimal |
document_location_approximate_region_latitude | bigdecimal |
document_location_approximate_city_name | string |
document_location_approximate_city_longitude | bigdecimal |
document_location_approximate_city_latitude | bigdecimal |
document_language_code | string |
document_image_link | string |
document_id | string |
document_hit_sentence | string |
document_hidden | boolean |
document_city | string |
Example
CREATE VIEW meltwater_examples.example_DocumentsRecurringExports
AS
SELECT * FROM meltwater.DocumentsRecurringExports (
export_id => '4096474'
)OneTimeExportCreate
Creates a new one-time export
Parameter
<searchIds> (required): List of search ids
<startDate> (optional): Start date of the export
<endDate> (optional): End date of the export
<tags> (optional): List of tag names
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | integer | Export Id |
tags | string | List of tag names used for the export |
updated_at | string | Updated Date |
status_reason | string | Status Reason |
status | string | Status |
start_date | string | Start Date |
end_date | string | End Date |
inserted_at | string | Inserted Date |
data_url | string | Data Url |
company_name | string | Company Name |
Example
CREATE VIEW meltwater_examples.example_OneTimeExportCreate
AS
SELECT * FROM meltwater.OneTimeExportCreate (
searchIds => '3331129'
)OneTimeExportDelete
Removes an existing one-time export
Parameter
<export_id> (required): One-time export id
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
status | string | Result |
Example
CREATE VIEW meltwater_examples.example_OneTimeExportDelete
AS
SELECT * FROM meltwater.OneTimeExportDelete (
export_id => '4096440'
)RecurringExportDelete
Removes an existing recurring export
Parameter
<export_id> (required): Recurring export id
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
status | string | Result |
Example
CREATE VIEW meltwater_examples.example_RecurringExportDelete
AS
SELECT * FROM meltwater.RecurringExportDelete (
export_id => '4096388'
)RecurringExportsCreate
Creates a new recurring export
Parameter
<searchIds> (required): List of search ids
<window_time_unit> (optional): Window Time Unit
<window_time> (optional): Window Time
<window_size> (optional): Window Size
<timezone> (optional): Timezone
<tags> (optional): List of tag names
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | integer | Export Id |
status_reason | string | Status Reason |
status | string | Status |
Example
CREATE VIEW meltwater_examples.example_RecurringExportsCreate
AS
SELECT * FROM meltwater.RecurringExportsCreate (
searchIds => '3331129'
)Searches
All your searches
Parameter
<search_id> (optional): Return individual search
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | integer | Search Id |
name | string | Search name |
updated | timestamp | The datetime the search was last updated |
type | string | The type of content that the search is for |
query_type | boolean | Query type |
query_source_selection_id | integer | Query source selection id |
query_case_sensitivity | string | Query case sensitivity |
query_boolean | string | Query boolean |
Example
CREATE VIEW meltwater_examples.example_Searches
AS
SELECT * FROM meltwater.Searches (
preview => TRUE
)SourceSelections
All your source selections
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | integer | ID of the source selection |
type | string | The type of searches this source selection can be used for |
name | string | Source selection name |
custom | boolean | If this source selection is a custom one or not |
Example
CREATE VIEW meltwater_examples.example_SourceSelections
AS
SELECT * FROM meltwater.SourceSelections (
preview => TRUE
)Tags
All your Tags
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
name | string | Tag name |
Example
CREATE VIEW meltwater_examples.example_Tags
AS
SELECT * FROM meltwater.Tags (
preview => TRUE
)