LianaMonitor API V1 Documentation (1.0.0)

Download OpenAPI specification:

LianaMonitor API V1 Documentation

Testing

Echo endpoints can be used to test whether OAuth2 authentication works.

Echo GET

Send any message in message path parameter and the same message should be returned with the 200 OK response.

Authorizations:

OAuth2ClientCredentials

query Parameters

message

required

string

Example: message=Hello world!

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/echo

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/echo

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/echo

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/echo

Response samples

Content type

application/json

{"href": "https://app.lianamonitor.com/api/v1/echo?message=Hello+world%21",
"message": "Hello world!",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Echo POST

Send any message in the request body and the same message should be returned with the 200 OK response.

Authorizations:

OAuth2ClientCredentials

Request Body schema: application/json
required

message

required

string

Send any message in message post parameter and the same message should be returned with the 200 OK response.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/echo

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/echo

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/echo

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/echo

Request samples

Payload

Content type

application/json

{"message": "Hello world!"
}

Response samples

Content type

application/json

{"href": "https://app.lianamonitor.com/api/v1/echo?message=Hello+world%21",
"message": "Hello world!",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Echo PUT

Send any message in the request body and the same message should be returned with the 200 OK response.

Authorizations:

OAuth2ClientCredentials

Request Body schema: application/json
required

message

required

string

Send any message in message post parameter and the same message should be returned with the 200 OK response.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/echo

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/echo

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/echo

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/echo

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/echo

Request samples

Payload

Content type

application/json

{"message": "Hello world!"
}

Response samples

Content type

application/json

{"href": "https://app.lianamonitor.com/api/v1/echo?message=Hello+world%21",
"message": "Hello world!",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Monitors

Information from multiple or specific monitors.

Get a list of monitors

Authorizations:

OAuth2ClientCredentials

query Parameters

limit	integer >= 1 Default: 20 Example: limit=30 The number of items to return.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.
sort	string Default: "id" Enum: "id" "name" Example: sort=-name Defines the column to use for sorting. For descending order, prepend the column name with `-`
active	string Enum: "true" "false" Example: active=true Limits results to either enabled or disabled monitors.
folder_id	integer Example: folder_id=1 Limits results into specific directory. If `null` string-value is given, returns results with no parent directory.
name	string Example: name=test Limit monitors to specific name. Adding an asterisk `*` before or after the name acts as an wildcard.
fields	string Enum: "id" "active" "description" "name" "created_at" "modified_at" "folder" "hits_count" "new_hits" "last_hit_at" "last_hit" "areas" "show_on_mobile" "feeds_rss_enabled" "feeds_rss_link" "feeds_rss_title" "feeds_html_enabled" "feeds_html_link" "feeds_html_title" "stack_similar_hits_enabled" "stack_similar_hits_condition" "stack_similar_hits_content_percent" "stack_similar_hits_title_percent" "keywords" "keywords_condition" "additional_keywords" "block_keywords" "ignore_keywords" "title_keywords" "title_keywords_condition" "title_block_keywords" "title_block_keywords_condition" "url_keywords" "url_block_keywords" "press_release" "languages" "countries" "author_keywords" "author_block_keywords" Example: fields=id,active,keywords Comma-separated list of returnable columns. If given, only requested columns are returned. Optional properties can only be fetched by defining them here. Optional fields: `hits_count` - Total hit count for monitor `new_hits` - Count of unread/new hits `last_hit_at` - Timestamp when the latest hit was created `last_hit` - ID of the latest hit `areas` - Monitor searches hits from these areas `show_on_mobile` - List this monitor on mobile application `feeds_rss_enabled` - Is public RSS hit list feed enabled for monitor `feeds_rss_link` - Link to public RSS hit list feed `feeds_rss_title` - Title for public RSS hit list feed `feeds_html_enabled` - Is public HTML hit list feed enabled for monitor `feeds_html_link` - Link to public HTML hit list feed `feeds_html_title` - Title for public HTML hit list feed `stack_similar_hits_enabled` - Is stacking similar hits option enabled for monitor `stack_similar_hits_condition` - Stacking similar hits condition `stack_similar_hits_content_percent` - Hit content must match given amount of percent to be stacked under another hit `stack_similar_hits_title_percent` - Hit title must match given amount of percent to be stacked under another hit `keywords` - Monitor search keywords `keywords_condition` - Condition for monitor keywords `additional_keywords` - In addition, article must contain at least one of the following words `block_keywords` - Article must not contain any of the following words `ignore_keywords` - Do not take following words into account at all `title_keywords` - Title must contain `title_keywords_condition` - Condition for title keywords `title_block_keywords` - Title must not contain `title_block_keywords_condition` - Condition for title block keywords `url_keywords` - Article URL must contain `url_block_keywords` - Article URL must not contain any of the following words `press_release` - Press release object for Monitor (If created from LianaPress press release) `languages` - Monitor languages filter for hits (Only for Social media monitors) `countries` - Monitor countries filter for hits (Only for Social media monitors) `author_keywords` - Monitor author keywords (Only for Social media monitors) `author_block_keywords` - Monitor block author keywords (Only for Social media monitors)

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors

Response samples

Content type

application/json

{"items": [{"id": 11,
"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"folder": {"name": "TestFolder",
"id": 0
},
"hits_count": 142,
"new_hits": 0,
"last_hit_at": "2019-08-24T14:15:22Z",
"last_hit": 55021,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_link": "string",
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_link": "string",
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
]
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Create a new monitor

Create a new monitor with payload found in request body.

Authorizations:

OAuth2ClientCredentials

Request Body schema: application/json
required

active	boolean Monitor activity.
description	string or null Monitor description.
name	string Name of the monitor.
folder_id	integer or null Folder ID where to save monitor. (null = root)
show_on_mobile	boolean List this monitor on mobile application.
feeds_rss_enabled	boolean Enable public RSS hit list feed for monitor.
feeds_rss_title	string or null Title for public RSS hit list feed.
feeds_html_enabled	boolean Enable public HTML hit list feed for monitor.
feeds_html_title	string or null Title for public HTML hit list feed.
stack_similar_hits_enabled	boolean Stack new similar hits
stack_similar_hits_condition	string Enum: "title" "content" "title_and_content" "title_or_content" Stacking similar hits condition.
stack_similar_hits_content_percent	integer [ 1 .. 100 ] Hit content must match given amount of percent to be stacked under another hit. (not used if `stack_similar_hits_condition=title`)
stack_similar_hits_title_percent	integer [ 1 .. 100 ] Hit title must match given amount of percent to be stacked under another hit. (not used if `stack_similar_hits_condition=content`)
areas	Array of arrays (MonitorAreas) Monitor searches hits from these areas
keywords	Array of strings (MonitorKeywords) Article must contain keywords.
keywords_condition	string (MonitorKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words
additional_keywords	Array of strings or null (MonitorAdditionalKeywords) In addition, article must contain at least one of the following words.
block_keywords	Array of strings or null (MonitorBlockKeywords) Article must not contain any of the following words.
ignore_keywords	Array of strings or null (MonitorIgnoreKeywords) Do not take following words into account at all.
title_keywords	Array of strings or null (MonitorTitleKeywords) Title must contain.
title_keywords_condition	string or null (MonitorOtherKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words Can be null if condition's keyword is null.
title_block_keywords	Array of strings or null (MonitorTitleBlockKeywords) Title must not contain.
title_block_keywords_condition	string or null (MonitorOtherKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words Can be null if condition's keyword is null.
url_keywords	Array of strings or null (MonitorURLKeywords) Article URL must contain.
url_block_keywords	Array of strings or null (MonitorURLBlockKeywords) Article URL must not contain any of the following words.
languages	Array of strings or null (MonitorLanguages) The social media post must be in one of the specified languages. Required for the social media monitor.
countries	Array of strings or null (MonitorCountries) The social media post must be associated with one of the specified countries. Only for the social media monitor.
author_keywords	Array of strings or null (MonitorAuthorKeywords) The social media post must have been made by one of the specified authors, with support for exact matches only. Only for the social media monitor.
author_block_keywords	Array of strings or null (MonitorAuthorBlockKeywords) The social media post must not have been made by any of the specified authors, with support for exact matches only. Only for the social media monitor.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors

Request samples

Payload

Content type

application/json

{"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"folder_id": 0,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
]
}

Response samples

Content type

application/json

{"id": 11,
"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"folder": {"name": "TestFolder",
"id": 0
},
"hits_count": 142,
"new_hits": 0,
"last_hit_at": "2019-08-24T14:15:22Z",
"last_hit": 55021,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_link": "string",
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_link": "string",
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get a monitor

Authorizations:

OAuth2ClientCredentials

path Parameters

monitor_id

required

integer

ID of a monitor

query Parameters

fields

string

Enum: "id" "active" "description" "name" "created_at" "modified_at" "folder" "hits_count" "new_hits" "last_hit_at" "last_hit" "areas" "show_on_mobile" "feeds_rss_enabled" "feeds_rss_link" "feeds_rss_title" "feeds_html_enabled" "feeds_html_link" "feeds_html_title" "stack_similar_hits_enabled" "stack_similar_hits_condition" "stack_similar_hits_content_percent" "stack_similar_hits_title_percent" "keywords" "keywords_condition" "additional_keywords" "block_keywords" "ignore_keywords" "title_keywords" "title_keywords_condition" "title_block_keywords" "title_block_keywords_condition" "url_keywords" "url_block_keywords" "press_release" "languages" "countries" "author_keywords" "author_block_keywords"

Example: fields=id,active,keywords

Comma-separated list of returnable columns. If given, only requested columns are returned. Optional properties can only be fetched by defining them here. Optional fields:

hits_count - Total hit count for monitor
new_hits - Count of unread/new hits
last_hit_at - Timestamp when the latest hit was created
last_hit - ID of the latest hit
areas - Monitor searches hits from these areas
show_on_mobile - List this monitor on mobile application
feeds_rss_enabled - Is public RSS hit list feed enabled for monitor
feeds_rss_link - Link to public RSS hit list feed
feeds_rss_title - Title for public RSS hit list feed
feeds_html_enabled - Is public HTML hit list feed enabled for monitor
feeds_html_link - Link to public HTML hit list feed
feeds_html_title - Title for public HTML hit list feed
stack_similar_hits_enabled - Is stacking similar hits option enabled for monitor
stack_similar_hits_condition - Stacking similar hits condition
stack_similar_hits_content_percent - Hit content must match given amount of percent to be stacked under another hit
stack_similar_hits_title_percent - Hit title must match given amount of percent to be stacked under another hit
keywords - Monitor search keywords
keywords_condition - Condition for monitor keywords
additional_keywords - In addition, article must contain at least one of the following words
block_keywords - Article must not contain any of the following words
ignore_keywords - Do not take following words into account at all
title_keywords - Title must contain
title_keywords_condition - Condition for title keywords
title_block_keywords - Title must not contain
title_block_keywords_condition - Condition for title block keywords
url_keywords - Article URL must contain
url_block_keywords - Article URL must not contain any of the following words
press_release - Press release object for Monitor (If created from LianaPress press release)
languages - Monitor languages filter for hits (Only for Social media monitors)
countries - Monitor countries filter for hits (Only for Social media monitors)
author_keywords - Monitor author keywords (Only for Social media monitors)
author_block_keywords - Monitor block author keywords (Only for Social media monitors)

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors/{monitor_id}

Response samples

Content type

application/json

{"id": 11,
"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"folder": {"name": "TestFolder",
"id": 0
},
"hits_count": 142,
"new_hits": 0,
"last_hit_at": "2019-08-24T14:15:22Z",
"last_hit": 55021,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_link": "string",
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_link": "string",
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Edit existing monitor

Edit existing monitor with payload found in request body.

Authorizations:

OAuth2ClientCredentials

path Parameters

monitor_id

required

integer

ID of a monitor

Request Body schema: application/json
required

active	boolean Monitor activity.
description	string or null Monitor description.
name	string Name of the monitor.
folder_id	integer or null Folder ID where to save monitor. (null = root)
show_on_mobile	boolean List this monitor on mobile application.
feeds_rss_enabled	boolean Enable public RSS hit list feed for monitor.
feeds_rss_title	string or null Title for public RSS hit list feed.
feeds_html_enabled	boolean Enable public HTML hit list feed for monitor.
feeds_html_title	string or null Title for public HTML hit list feed.
stack_similar_hits_enabled	boolean Stack new similar hits
stack_similar_hits_condition	string Enum: "title" "content" "title_and_content" "title_or_content" Stacking similar hits condition.
stack_similar_hits_content_percent	integer [ 1 .. 100 ] Hit content must match given amount of percent to be stacked under another hit. (not used if `stack_similar_hits_condition=title`)
stack_similar_hits_title_percent	integer [ 1 .. 100 ] Hit title must match given amount of percent to be stacked under another hit. (not used if `stack_similar_hits_condition=content`)
areas	Array of arrays (MonitorAreas) Monitor searches hits from these areas
keywords	Array of strings (MonitorKeywords) Article must contain keywords.
keywords_condition	string (MonitorKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words
additional_keywords	Array of strings or null (MonitorAdditionalKeywords) In addition, article must contain at least one of the following words.
block_keywords	Array of strings or null (MonitorBlockKeywords) Article must not contain any of the following words.
ignore_keywords	Array of strings or null (MonitorIgnoreKeywords) Do not take following words into account at all.
title_keywords	Array of strings or null (MonitorTitleKeywords) Title must contain.
title_keywords_condition	string or null (MonitorOtherKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words Can be null if condition's keyword is null.
title_block_keywords	Array of strings or null (MonitorTitleBlockKeywords) Title must not contain.
title_block_keywords_condition	string or null (MonitorOtherKeywordCondition) Enum: "OR" "AND" `OR` Any of the following words `AND` All of the following words Can be null if condition's keyword is null.
url_keywords	Array of strings or null (MonitorURLKeywords) Article URL must contain.
url_block_keywords	Array of strings or null (MonitorURLBlockKeywords) Article URL must not contain any of the following words.
languages	Array of strings or null (MonitorLanguages) The social media post must be in one of the specified languages. Required for the social media monitor.
countries	Array of strings or null (MonitorCountries) The social media post must be associated with one of the specified countries. Only for the social media monitor.
author_keywords	Array of strings or null (MonitorAuthorKeywords) The social media post must have been made by one of the specified authors, with support for exact matches only. Only for the social media monitor.
author_block_keywords	Array of strings or null (MonitorAuthorBlockKeywords) The social media post must not have been made by any of the specified authors, with support for exact matches only. Only for the social media monitor.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors/{monitor_id}

Request samples

Payload

Content type

application/json

{"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"folder_id": 0,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
]
}

Response samples

Content type

application/json

{"id": 11,
"active": true,
"description": "My test monitor",
"name": "TestMonitor",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"folder": {"name": "TestFolder",
"id": 0
},
"hits_count": 142,
"new_hits": 0,
"last_hit_at": "2019-08-24T14:15:22Z",
"last_hit": 55021,
"show_on_mobile": true,
"feeds_rss_enabled": true,
"feeds_rss_link": "string",
"feeds_rss_title": "string",
"feeds_html_enabled": true,
"feeds_html_link": "string",
"feeds_html_title": "string",
"stack_similar_hits_enabled": true,
"stack_similar_hits_condition": "title",
"stack_similar_hits_content_percent": 1,
"stack_similar_hits_title_percent": 1,
"areas": ["FI",
"RU",
"DE"
],
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"keywords_condition": "OR",
"additional_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"ignore_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_keywords_condition": "OR",
"title_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"title_block_keywords_condition": "OR",
"url_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"url_block_keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
],
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"languages": ["FI",
"RU",
"DE"
],
"countries": ["FI",
"RU",
"DE"
],
"author_keywords": ["John Doe"
],
"author_block_keywords": ["Don Joe"
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Delete monitor

Delete existing monitor.

Authorizations:

OAuth2ClientCredentials

path Parameters

monitor_id

required

integer

ID of a monitor

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors/{monitor_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors/{monitor_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors/{monitor_id}

Response samples

Content type

application/json

{"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get a list of hits for the requested monitor

Authorizations:

OAuth2ClientCredentials

path Parameters

monitor_id

required

integer

ID of a monitor

query Parameters

limit	integer >= 1 Default: 20 Example: limit=30 The number of items to return.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.
fields	string Enum: "id" "href" "monitor" "monitor.keywords" "tags" "summary" "collection" "published_at" "view_count" "rating" "ai_rating" "ai_confidence" "title" "highlight" "source" "source.ranking" "source.circulation" "source.reach" "thumbnail_url_small" "thumbnail_url_square" "has_image" "has_keywords_in_title" "has_keywords_in_lead_paragraph" "keywords" "keywords_found" "keywords_found_total" "keywords_percentage" "reach" "author" Example: fields=id,monitor,collection Comma-separated list of returnable columns. If given, only requested columns are returned. Optional properties can only be fetched by defining them here. Optional fields: `collection` - List of hit's collections `tags` - List of hit's tags `summary` - Summary text for hit `monitor.keywords` - Hit's monitor search keyword `ai_rating` - AI rating for hit `ai_confidence` - AI confidence for rating `has_image` - Does hit has image `has_keywords_in_lead_paragraph` - Is there matched keywords in lead paragraph `has_keywords_in_title` - Is there matched keyword in title `keywords` - Hit's matched keywords and counts `keywords_found` - Number of unique keywords found `keywords_found_total` - Number of keywords found in total `keywords_percentage` - Relative percentage of keywords in title and highlighted section `source.circulation` - Circulation of the hit's source `source.reach` - Reach of the hit's source `reach` - Hit's reach `author` - Hit's author
sort	string Default: "id" Enum: "id" "published_at" Example: sort=-published_at Defines the column to use for sorting. For descending order, prepend the column name with `-`
q	string Example: q=test* Filter hits by given search word. Allows using an asterisk `*` prepending or appending the search word.
from_id	integer Example: from_id=12 Search hits where ID is greater than given ID.
to_id	integer Example: to_id=34 Search hits where ID is less than given ID.
from	string <date-time> Example: from=2017-07-20T17:32:28Z Search hits published after given timestamp.
to	string <date-time> Example: to=2018-01-08T15:52:01+00:00 Search hits published before given timestamp.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors/{monitor_id}/hits

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors/{monitor_id}/hits

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors/{monitor_id}/hits

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors/{monitor_id}/hits

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors/{monitor_id}/hits

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors/{monitor_id}/hits

Response samples

Content type

application/json

{"items": [{"id": 123,
"href": "https://app.lianamonitor.com/api/v1/monitors/1/hits/123",
"monitor": {"name": "Monitor",
"id": 1,
"href": "https://app.lianamonitor.com/api/v1/monitors/1/",
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
]
},
"tags": [{"id": 1,
"name": "tag1"
}
],
"summary": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet lectus eget ex convallis accumsan id ut purus.,\n",
"collection": [{"id": 1,
"name": "Collection test"
}
],
"published_at": "2019-08-24T14:15:22Z",
"view_count": 1,
"rating": 1,
"ai_rating": 1,
"ai_confidence": 0.89,
"title": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
"highlight": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet lectus eget ex convallis accumsan id ut purus.,\n",
"source": {"id": 1,
"name": "Ilkka-Pohjalainen",
"favicon": "https://app.lianamonitor.com/static/favicon/29648031291c8e3fbb859213285a57ec.png?202106",
"url": "https://ilkkapohjalainen.fi/",
"document": {"id": "e089f757326b7a9258adaa67ac64055e",
"url": "https://ilkkapohjalainen.fi/uutiset/kotimaa/eduskunnassa-valtiopaivien-avauskeskustelu-hallituksen-politiikasta-1.11846335",
"image_url": "https://ilkkapohjalainen.fi/img/imediat-img/fb_Ilkka-Pohjalainen_300x300.jpg",
"thumbnail_url": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2.jpg",
"thumbnail_url_small": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2_small.jpg",
"thumbnail_url_square": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2_square.jpg"
},
"ranking": 0,
"circulation": 0,
"reach": 116961
},
"has_image": true,
"has_keywords_in_title": true,
"has_keywords_in_lead_paragraph": true,
"keywords": {"keyword1": 10,
"keyword2": 2
},
"keywords_found": 2,
"keywords_found_total": 12,
"keywords_percentage": 10,
"reach": 1230000,
"author": "John Doe"
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get a hit from specific monitor

Fetch specific hit inside a monitor.

Authorizations:

OAuth2ClientCredentials

path Parameters

monitor_id required	integer ID of a monitor
hit_id required	integer ID of a hit

query Parameters

fields

string

Enum: "id" "href" "monitor" "monitor.keywords" "tags" "summary" "collection" "published_at" "view_count" "rating" "ai_rating" "ai_confidence" "title" "highlight" "source" "source.ranking" "source.circulation" "source.reach" "thumbnail_url_small" "thumbnail_url_square" "has_image" "has_keywords_in_title" "has_keywords_in_lead_paragraph" "keywords" "keywords_found" "keywords_found_total" "keywords_percentage" "reach" "author"

Example: fields=id,monitor,collection

Comma-separated list of returnable columns. If given, only requested columns are returned. Optional properties can only be fetched by defining them here. Optional fields:

collection - List of hit's collections
tags - List of hit's tags
summary - Summary text for hit
monitor.keywords - Hit's monitor search keyword
ai_rating - AI rating for hit
ai_confidence - AI confidence for rating
has_image - Does hit has image
has_keywords_in_lead_paragraph - Is there matched keywords in lead paragraph
has_keywords_in_title - Is there matched keyword in title
keywords - Hit's matched keywords and counts
keywords_found - Number of unique keywords found
keywords_found_total - Number of keywords found in total
keywords_percentage - Relative percentage of keywords in title and highlighted section
source.circulation - Circulation of the hit's source
source.reach - Reach of the hit's source
reach - Hit's reach
author - Hit's author

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/monitors/{monitor_id}/hits/{hit_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/monitors/{monitor_id}/hits/{hit_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/monitors/{monitor_id}/hits/{hit_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/monitors/{monitor_id}/hits/{hit_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/monitors/{monitor_id}/hits/{hit_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/monitors/{monitor_id}/hits/{hit_id}

Response samples

Content type

application/json

{"id": 123,
"href": "https://app.lianamonitor.com/api/v1/monitors/1/hits/123",
"monitor": {"name": "Monitor",
"id": 1,
"href": "https://app.lianamonitor.com/api/v1/monitors/1/",
"keywords": ["keyword",
"\\\"exact\\\"",
"wildcard*",
"proximity...keyword"
]
},
"tags": [{"id": 1,
"name": "tag1"
}
],
"summary": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet lectus eget ex convallis accumsan id ut purus.,\n",
"collection": [{"id": 1,
"name": "Collection test"
}
],
"published_at": "2019-08-24T14:15:22Z",
"view_count": 1,
"rating": 1,
"ai_rating": 1,
"ai_confidence": 0.89,
"title": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
"highlight": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet lectus eget ex convallis accumsan id ut purus.,\n",
"source": {"id": 1,
"name": "Ilkka-Pohjalainen",
"favicon": "https://app.lianamonitor.com/static/favicon/29648031291c8e3fbb859213285a57ec.png?202106",
"url": "https://ilkkapohjalainen.fi/",
"document": {"id": "e089f757326b7a9258adaa67ac64055e",
"url": "https://ilkkapohjalainen.fi/uutiset/kotimaa/eduskunnassa-valtiopaivien-avauskeskustelu-hallituksen-politiikasta-1.11846335",
"image_url": "https://ilkkapohjalainen.fi/img/imediat-img/fb_Ilkka-Pohjalainen_300x300.jpg",
"thumbnail_url": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2.jpg",
"thumbnail_url_small": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2_small.jpg",
"thumbnail_url_square": "https://img.lianamonitor.com/f30/a86/f30a869e0ffe9bcfc6e4b3f89df56da2_square.jpg"
},
"ranking": 0,
"circulation": 0,
"reach": 116961
},
"has_image": true,
"has_keywords_in_title": true,
"has_keywords_in_lead_paragraph": true,
"keywords": {"keyword1": 10,
"keyword2": 2
},
"keywords_found": 2,
"keywords_found_total": 12,
"keywords_percentage": 10,
"reach": 1230000,
"author": "John Doe",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Hit reports

Get list of hit reports

Authorizations:

OAuth2ClientCredentials

query Parameters

limit	integer >= -1 Default: 20 Example: limit=30 The number of items to return. For no limit use value `-1`.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.
sort	string Default: "id" Enum: "id" "name" "next_delivery" Example: sort=-name Defines the column to use for sorting. For descending order, prepend the column name with `-`
active	string Enum: "true" "false" Example: active=true Limits results to either enabled or disabled hit reports.
folder_id	integer or null Example: folder_id=1 Limits results into specific directory. If `null` string-value is given, returns results with no parent directory.
q	string Example: q=test* Filter hit reports by given search word. Allows using an asterisk `*` prepending or appending the search word. Filter reports by name and recipient email addresses.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports

Response samples

Content type

application/json

{"items": [{"id": 10,
"active": true,
"name": "Test report",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"next_delivery_at": "2019-08-24T14:15:22Z",
"folder": {"id": 10,
"name": "Testing folder"
},
"monitors": [{"id": 10,
"name": "Testing monitor"
}
],
"language": "FI",
"monitor_hit_limit": 55,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule": {"timezone": "Europe/Helsinki",
"interval": "selected_times",
"day_of_weeks": [0,
2
],
"time_of_days": ["01:00",
"13:37"
]
}
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Create a new hit report

Authorizations:

OAuth2ClientCredentials

Request Body schema: application/json
required

active	boolean (HitReportActive) Hit report's activity. When active deliveries are sent when scheduled.
name required	string (HitReportName) Name of the hit report.
folder_id	integer or null (HitReportFolderID) Folder ID where to save hit report. (null = root)
monitor_ids required	Array of integers (HitReportMonitorIDs) Monitors to be linked with hit report. When a new hit is founded to these monitors it is added to hit report.
language	string Enum: "FI" "SV" "EN" "DE" "FR" "RU" "PT" Hit report's language. User's language is used for new hit report if not given via payload.
recipients required	Array of strings (HitReportRecipients) Array of email addresses to be added as recipients for the hit report.
monitor_hit_limit	integer [ 1 .. 100 ] Default: 20 Amount of hits for each selected monitors in the email. Uses default value if not given via payload.
template	string Default: "normal" Enum: "normal" "plain" Email report template. Uses default value if not given via payload.
template_settings	Array of strings or null (HitReportTemplateSettings) Enum: "hit_actions" "hit_images" "hit_keywords" "hit_some_share_actions" "monitor_chart" "monitor_summary" "only_monitors_with_hits" "report_actions" "translate_hit_link" Email report settings
send_threshold	integer or null (HitReportSendThreshold) [ 1 .. 1000 ] Send only if new hits amount is at least given value. If value is null sends report even if there's no new hits.
schedule_timezone required	string (ScheduleTimezone) Timezone for hit report's schedule.
schedule_interval required	string (ScheduleInterval) Enum: "bimonthly" "biweekly" "monthly" "quarter_hourly" "quarter_yearly" "selected_days" "selected_times" "six_monthly" "weekly" "yearly" Interval for schedule.
schedule_day_of_weeks	Array of integers or null (ScheduleDayOfWeeks) Day of week options when to send the delivery. 0 (for Sunday) through 6 (for Saturday). Not `Nullable` when schedule interval options is any of the following: `selected_days` `weekly` (Only one option is allowed)
schedule_time_of_days	Array of strings or null (ScheduleTimeOfDays) Time of day options when to send the delivery. Not `Nullable` when schedule interval options is any of the following: `selected_days` `selected_times` `weekly`
schedule_next_delivery	string <date-time> (ScheduleNextDeliveryTime) When to send next hit report's delivery. If not given via payload `next_delivery_at` is calculated based on schedule settings.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports

Request samples

Payload

Content type

application/json

{"active": true,
"name": "Test report",
"folder_id": 10,
"monitor_ids": [1,
2,
10
],
"language": "FI",
"recipients": ["testing@example.com"
],
"monitor_hit_limit": 20,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule_timezone": "Europe/Helsinki",
"schedule_interval": "selected_times",
"schedule_day_of_weeks": [0,
2
],
"schedule_time_of_days": ["01:00",
"13:37"
],
"schedule_next_delivery": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 10,
"active": true,
"name": "Test report",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"next_delivery_at": "2019-08-24T14:15:22Z",
"folder": {"id": 10,
"name": "Testing folder"
},
"monitors": [{"id": 10,
"name": "Testing monitor"
}
],
"language": "FI",
"monitor_hit_limit": 55,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule": {"timezone": "Europe/Helsinki",
"interval": "selected_times",
"day_of_weeks": [0,
2
],
"time_of_days": ["01:00",
"13:37"
]
},
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get a hit report

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id

required

integer

ID of the hit report

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}

Response samples

Content type

application/json

{"id": 10,
"active": true,
"name": "Test report",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"next_delivery_at": "2019-08-24T14:15:22Z",
"folder": {"id": 10,
"name": "Testing folder"
},
"monitors": [{"id": 10,
"name": "Testing monitor"
}
],
"language": "FI",
"monitor_hit_limit": 55,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule": {"timezone": "Europe/Helsinki",
"interval": "selected_times",
"day_of_weeks": [0,
2
],
"time_of_days": ["01:00",
"13:37"
]
},
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Edit existing hit report

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id

required

integer

ID of the hit report

Request Body schema: application/json
required

active	boolean (HitReportActive) Hit report's activity. When active deliveries are sent when scheduled.
name	string (HitReportName) Name of the hit report.
folder_id	integer or null (HitReportFolderID) Folder ID where to save hit report. (null = root)
monitor_ids	Array of integers (HitReportMonitorIDs) Monitors to be linked with hit report. When a new hit is founded to these monitors it is added to hit report.
language	string (HitReportLanguage) Enum: "FI" "SV" "EN" "DE" "FR" "RU" "PT" Hit report's language.
monitor_hit_limit	integer (HitReportMonitorHitLimit) [ 1 .. 100 ] Amount of hits for each selected monitors in the email.
template	string (HitReportTemplate) Enum: "normal" "plain" Email report template
template_settings	Array of strings or null (HitReportTemplateSettings) Enum: "hit_actions" "hit_images" "hit_keywords" "hit_some_share_actions" "monitor_chart" "monitor_summary" "only_monitors_with_hits" "report_actions" "translate_hit_link" Email report settings
send_threshold	integer or null (HitReportSendThreshold) [ 1 .. 1000 ] Send only if new hits amount is at least given value. If value is null sends report even if there's no new hits.
schedule_timezone	string (ScheduleTimezone) Timezone for hit report's schedule.
schedule_interval	string (ScheduleInterval) Enum: "bimonthly" "biweekly" "monthly" "quarter_hourly" "quarter_yearly" "selected_days" "selected_times" "six_monthly" "weekly" "yearly" Interval for schedule.
schedule_day_of_weeks	Array of integers or null (ScheduleDayOfWeeks) Day of week options when to send the delivery. 0 (for Sunday) through 6 (for Saturday). Not `Nullable` when schedule interval options is any of the following: `selected_days` `weekly` (Only one option is allowed)
schedule_time_of_days	Array of strings or null (ScheduleTimeOfDays) Time of day options when to send the delivery. Not `Nullable` when schedule interval options is any of the following: `selected_days` `selected_times` `weekly`
schedule_next_delivery	string <date-time> (ScheduleNextDeliveryTime) When to send next hit report's delivery. If not given via payload `next_delivery_at` is calculated based on schedule settings.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}

Request samples

Payload

Content type

application/json

{"active": true,
"name": "Test report",
"folder_id": 10,
"monitor_ids": [1,
2,
10
],
"language": "FI",
"monitor_hit_limit": 55,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule_timezone": "Europe/Helsinki",
"schedule_interval": "selected_times",
"schedule_day_of_weeks": [0,
2
],
"schedule_time_of_days": ["01:00",
"13:37"
],
"schedule_next_delivery": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 10,
"active": true,
"name": "Test report",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"next_delivery_at": "2019-08-24T14:15:22Z",
"folder": {"id": 10,
"name": "Testing folder"
},
"monitors": [{"id": 10,
"name": "Testing monitor"
}
],
"language": "FI",
"monitor_hit_limit": 55,
"template": "normal",
"template_settings": ["hit_actions",
"hit_images",
"monitor_chart"
],
"send_threshold": 1,
"schedule": {"timezone": "Europe/Helsinki",
"interval": "selected_times",
"day_of_weeks": [0,
2
],
"time_of_days": ["01:00",
"13:37"
]
},
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Delete existing hit report

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id

required

integer

ID of the hit report

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}

Response samples

Content type

application/json

{"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get list of hit report's recipients

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id

required

integer

ID of the hit report

query Parameters

limit	integer >= -1 Default: 20 Example: limit=30 The number of items to return. For no limit use value `-1`.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.
sort	string Default: "subscribed_at" Enum: "email" "subscription_type" "subscribed_at" Example: sort=-subscription_type Defines the column to use for sorting. For descending order, prepend the column name with `-`
q	string Example: q=@domain.com Filter hit report recipient by given search word. Allows using an asterisk `` prepending or appending the search word.
subscription_type	string Enum: "subscribed" "manually_added" Filter recipients by their subscription type.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

Response samples

Content type

application/json

{"items": [{"id": 100,
"email": "testing@example.com",
"subscription_type": "manually_added",
"subscribed_at": "2019-08-24T14:15:22Z"
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Add new recipient to hit report

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id

required

integer

ID of the hit report

Request Body schema: application/json
required

required

string (RecipientEmail)

Recipient's email address.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients

Request samples

Payload

Content type

application/json

{"email": "testing@example.com"
}

Response samples

Content type

application/json

{"id": 100,
"email": "testing@example.com",
"subscription_type": "manually_added",
"subscribed_at": "2019-08-24T14:15:22Z",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get hit report's recipient

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id required	integer ID of the hit report
recipient_id required	integer ID of the recipeint

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

Response samples

Content type

application/json

{"id": 100,
"email": "testing@example.com",
"subscription_type": "manually_added",
"subscribed_at": "2019-08-24T14:15:22Z",
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Delete hit report's recipient

Authorizations:

OAuth2ClientCredentials

path Parameters

report_id required	integer ID of the hit report
recipient_id required	integer ID of the recipeint

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/hit_reports/{report_id}/recipients/{recipient_id}

Response samples

Content type

application/json

{"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Press releases

Get list of press releases

Authorizations:

OAuth2ClientCredentials

query Parameters

limit	integer >= -1 Default: 20 Example: limit=30 The number of items to return. For no limit use value `-1`.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.
publisher_id	integer Example: publisher_id=1 Filter results by specific publisher.
published_before	string <date-time> Example: published_before=2017-01-01T01:01:01Z Filter results that are published before given datetime.
published_after	string <date-time> Example: published_after=2017-01-01T01:01:01Z Filter results that are published after given datetime.
sort	string Default: "id" Value: "published_at" Example: sort=-published_at Defines the column to use for sorting. For descending order, prepend the column name with `-`

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/press_releases

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/press_releases

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/press_releases

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/press_releases

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/press_releases

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/press_releases

Response samples

Content type

application/json

{"items": [{"id": 10,
"monitor": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/monitors/1"
},
"type": "press_release",
"publisher": {"id": 1,
"name": "Test Publisher"
},
"published_at": "2019-08-24T14:15:22Z",
"publications": ["https://www.epressi.com/tiedotteet/talous/lorem-ipsum.html"
],
"title": "Lorem ipsum dolor sit amet",
"content": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dapibus nulla a lectus pretium suscipit. Morbi lobortis arcu lectus, et suscipit dolor eleifend id. Nunc viverra ipsum eget nulla porttitor aliquet. Vestibulum vitae purus volutpat, ornare arcu id, aliquet velit. Aliquam scelerisque et orci in efficitur. Nunc finibus metus sed nisi accumsan, vel luctus nunc auctor. Phasellus nulla tellus, blandit vitae ultricies ac, pellentesque vitae lectus. Cras volutpat velit dolor, quis congue urna accumsan at. Duis quis iaculis turpis. Cras vitae erat feugiat, porttitor nibh vitae, convallis odio. Maecenas auctor ac dolor id vulputate. Ut vel est mollis, rutrum leo ornare, congue nunc. Vestibulum felis sapien, scelerisque eget enim at, ultrices dapibus metus. Fusce in augue interdum, suscipit nibh in, vestibulum felis. Praesent scelerisque nisi in tempus sollicitudin. Mauris varius justo non velit varius, eget egestas purus tincidunt.</p>",
"lead": "<p>Lorem ipsum dolor sit amet</p>",
"company_introdution": "<p>Lorem ipsum dolor sit amet</p>",
"language": "FI",
"attachments": ["https://www.epressi.com/media/userfiles/137557/1570440000/liana_employees_with_bikes.jpg"
],
"categories": ["Tietokoneet",
"Talous"
],
"statistics": {"click_count": 200,
"click_ratio": 0.0252,
"delivery_count": 2,
"hit_count": 100,
"open_ratio": 0.2,
"opener_count": 130,
"recipient_count": 130
}
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get a press release

Authorizations:

OAuth2ClientCredentials

path Parameters

press_release_id

required

integer

ID of the press release

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/press_releases/{press_release_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/press_releases/{press_release_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/press_releases/{press_release_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/press_releases/{press_release_id}

Response samples

Content type

application/json

{"id": 10,
"monitor": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/monitors/1"
},
"type": "press_release",
"publisher": {"id": 1,
"name": "Test Publisher"
},
"published_at": "2019-08-24T14:15:22Z",
"publications": ["https://www.epressi.com/tiedotteet/talous/lorem-ipsum.html"
],
"title": "Lorem ipsum dolor sit amet",
"content": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dapibus nulla a lectus pretium suscipit. Morbi lobortis arcu lectus, et suscipit dolor eleifend id. Nunc viverra ipsum eget nulla porttitor aliquet. Vestibulum vitae purus volutpat, ornare arcu id, aliquet velit. Aliquam scelerisque et orci in efficitur. Nunc finibus metus sed nisi accumsan, vel luctus nunc auctor. Phasellus nulla tellus, blandit vitae ultricies ac, pellentesque vitae lectus. Cras volutpat velit dolor, quis congue urna accumsan at. Duis quis iaculis turpis. Cras vitae erat feugiat, porttitor nibh vitae, convallis odio. Maecenas auctor ac dolor id vulputate. Ut vel est mollis, rutrum leo ornare, congue nunc. Vestibulum felis sapien, scelerisque eget enim at, ultrices dapibus metus. Fusce in augue interdum, suscipit nibh in, vestibulum felis. Praesent scelerisque nisi in tempus sollicitudin. Mauris varius justo non velit varius, eget egestas purus tincidunt.</p>",
"lead": "<p>Lorem ipsum dolor sit amet</p>",
"company_introdution": "<p>Lorem ipsum dolor sit amet</p>",
"language": "FI",
"attachments": ["https://www.epressi.com/media/userfiles/137557/1570440000/liana_employees_with_bikes.jpg"
],
"categories": ["Tietokoneet",
"Talous"
],
"statistics": {"click_count": 200,
"click_ratio": 0.0252,
"delivery_count": 2,
"hit_count": 100,
"open_ratio": 0.2,
"opener_count": 130,
"recipient_count": 130
},
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get list of press release's deliveries

Authorizations:

OAuth2ClientCredentials

path Parameters

press_release_id

required

integer

ID of the press release

query Parameters

limit	integer >= -1 Default: 20 Example: limit=30 The number of items to return. For no limit use value `-1`.
offset	integer >= 0 Default: 0 Example: offset=10 The number of items to skip.

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}/deliveries

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}/deliveries

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries

Response samples

Content type

application/json

{"items": [{"id": 100,
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"publisher": {"id": 1,
"name": "Test Publisher"
},
"delivered_at": "2019-08-24T14:15:22Z",
"title": "Lorem ipsum dolor sit amet",
"content": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dapibus nulla a lectus pretium suscipit. Morbi lobortis arcu lectus, et suscipit dolor eleifend id. Nunc viverra ipsum eget nulla porttitor aliquet. Vestibulum vitae purus volutpat, ornare arcu id, aliquet velit. Aliquam scelerisque et orci in efficitur. Nunc finibus metus sed nisi accumsan, vel luctus nunc auctor. Phasellus nulla tellus, blandit vitae ultricies ac, pellentesque vitae lectus. Cras volutpat velit dolor, quis congue urna accumsan at. Duis quis iaculis turpis. Cras vitae erat feugiat, porttitor nibh vitae, convallis odio. Maecenas auctor ac dolor id vulputate. Ut vel est mollis, rutrum leo ornare, congue nunc. Vestibulum felis sapien, scelerisque eget enim at, ultrices dapibus metus. Fusce in augue interdum, suscipit nibh in, vestibulum felis. Praesent scelerisque nisi in tempus sollicitudin. Mauris varius justo non velit varius, eget egestas purus tincidunt.</p>",
"lead": "<p>Lorem ipsum dolor sit amet</p>",
"company_introduction": "<p>Lorem ipsum dolor sit amet</p>",
"sender_name": "Test Publisher",
"sender_email": "user@example.com",
"reply_to_email": "user@example.com",
"language": "FI",
"statistics": {"click_count": 30,
"click_ratio": 0.2027,
"open_ratio": 0.6014,
"opener_count": 89,
"recipient_count": 150,
"updated_at": "2019-08-24T14:15:22Z"
}
}
],
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

Get press release's delivery

Authorizations:

OAuth2ClientCredentials

path Parameters

press_release_id required	integer ID of the press release
delivery_id required	integer ID of the delivery

Responses

LianaMonitor production server #1

https://app.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

LianaMonitor production server #2

https://app.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

LianaMonitor production server #3

https://app2.viidakkomonitor.fi/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

LianaMonitor production server #4

https://app2.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

LianaMonitor beta server

https://beta.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

LianaMonitor staging server

https://staging.lianamonitor.com/api/v1/press_releases/{press_release_id}/deliveries/{delivery_id}

Response samples

Content type

application/json

{"id": 100,
"press_release": {"id": 1,
"href": "https://app.lianamonitor.com/api/v1/press_releases/1"
},
"publisher": {"id": 1,
"name": "Test Publisher"
},
"delivered_at": "2019-08-24T14:15:22Z",
"title": "Lorem ipsum dolor sit amet",
"content": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer dapibus nulla a lectus pretium suscipit. Morbi lobortis arcu lectus, et suscipit dolor eleifend id. Nunc viverra ipsum eget nulla porttitor aliquet. Vestibulum vitae purus volutpat, ornare arcu id, aliquet velit. Aliquam scelerisque et orci in efficitur. Nunc finibus metus sed nisi accumsan, vel luctus nunc auctor. Phasellus nulla tellus, blandit vitae ultricies ac, pellentesque vitae lectus. Cras volutpat velit dolor, quis congue urna accumsan at. Duis quis iaculis turpis. Cras vitae erat feugiat, porttitor nibh vitae, convallis odio. Maecenas auctor ac dolor id vulputate. Ut vel est mollis, rutrum leo ornare, congue nunc. Vestibulum felis sapien, scelerisque eget enim at, ultrices dapibus metus. Fusce in augue interdum, suscipit nibh in, vestibulum felis. Praesent scelerisque nisi in tempus sollicitudin. Mauris varius justo non velit varius, eget egestas purus tincidunt.</p>",
"lead": "<p>Lorem ipsum dolor sit amet</p>",
"company_introduction": "<p>Lorem ipsum dolor sit amet</p>",
"sender_name": "Test Publisher",
"sender_email": "user@example.com",
"reply_to_email": "user@example.com",
"language": "FI",
"statistics": {"click_count": 30,
"click_ratio": 0.2027,
"open_ratio": 0.6014,
"opener_count": 89,
"recipient_count": 150,
"updated_at": "2019-08-24T14:15:22Z"
},
"meta": {"response_at": "2017-01-01T01:01:01Z"
}
}

LianaMonitor API V1 Documentation (1.0.0)

Testing

Echo GET

Authorizations:

query Parameters

Responses

Response samples

Echo POST

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Echo PUT

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Monitors

Get a list of monitors

Authorizations:

query Parameters

Responses

Response samples

Create a new monitor

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a monitor

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Edit existing monitor

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete monitor

Authorizations:

path Parameters

Responses

Response samples

Get a list of hits for the requested monitor

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get a hit from specific monitor

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Hit reports

Get list of hit reports

Authorizations:

query Parameters

Responses

Response samples

Create a new hit report

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a hit report

Authorizations:

path Parameters

Responses

Response samples

Edit existing hit report

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required