Update sentiment analysis configuration.
curl --request PUT \
--url https://apix.us.amity.co/v1/network-settings/sentiment-analysis \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enabled": false,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [
{
"name": "<string>"
}
]
}
],
"customPost": {
"enabled": false,
"dataTypeAllowlist": [],
"minTextComments": 10
}
}
'import requests
url = "https://apix.us.amity.co/v1/network-settings/sentiment-analysis"
payload = {
"enabled": False,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [{ "name": "<string>" }]
}
],
"customPost": {
"enabled": False,
"dataTypeAllowlist": [],
"minTextComments": 10
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: false,
monthlyQuota: 10000,
profiles: [
{
name: '<string>',
companyName: '<string>',
companyBackstory: '<string>',
topics: [{name: '<string>'}]
}
],
customPost: {enabled: false, dataTypeAllowlist: [], minTextComments: 10}
})
};
fetch('https://apix.us.amity.co/v1/network-settings/sentiment-analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/v1/network-settings/sentiment-analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => false,
'monthlyQuota' => 10000,
'profiles' => [
[
'name' => '<string>',
'companyName' => '<string>',
'companyBackstory' => '<string>',
'topics' => [
[
'name' => '<string>'
]
]
]
],
'customPost' => [
'enabled' => false,
'dataTypeAllowlist' => [
],
'minTextComments' => 10
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/v1/network-settings/sentiment-analysis"
payload := strings.NewReader("{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://apix.us.amity.co/v1/network-settings/sentiment-analysis")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/v1/network-settings/sentiment-analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"analyticConfigs": {
"sentimentAnalysisSetting": {
"enabled": false,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [
{
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
],
"customPost": {
"enabled": false,
"dataTypeAllowlist": [],
"minTextComments": 10,
"effectiveAt": "2023-11-07T05:31:56Z"
}
}
}
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Network Setting
Update sentiment analysis configuration.
Update the network’s sentiment analysis settings, including the customPost block that
extends the analysis to custom post types.
This leaf is served on the /v1 API-key surface, not on /api/v3 like the other network
setting leaves, and it is admin only.
PUT
/
v1
/
network-settings
/
sentiment-analysis
Update sentiment analysis configuration.
curl --request PUT \
--url https://apix.us.amity.co/v1/network-settings/sentiment-analysis \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enabled": false,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [
{
"name": "<string>"
}
]
}
],
"customPost": {
"enabled": false,
"dataTypeAllowlist": [],
"minTextComments": 10
}
}
'import requests
url = "https://apix.us.amity.co/v1/network-settings/sentiment-analysis"
payload = {
"enabled": False,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [{ "name": "<string>" }]
}
],
"customPost": {
"enabled": False,
"dataTypeAllowlist": [],
"minTextComments": 10
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: false,
monthlyQuota: 10000,
profiles: [
{
name: '<string>',
companyName: '<string>',
companyBackstory: '<string>',
topics: [{name: '<string>'}]
}
],
customPost: {enabled: false, dataTypeAllowlist: [], minTextComments: 10}
})
};
fetch('https://apix.us.amity.co/v1/network-settings/sentiment-analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/v1/network-settings/sentiment-analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => false,
'monthlyQuota' => 10000,
'profiles' => [
[
'name' => '<string>',
'companyName' => '<string>',
'companyBackstory' => '<string>',
'topics' => [
[
'name' => '<string>'
]
]
]
],
'customPost' => [
'enabled' => false,
'dataTypeAllowlist' => [
],
'minTextComments' => 10
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/v1/network-settings/sentiment-analysis"
payload := strings.NewReader("{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://apix.us.amity.co/v1/network-settings/sentiment-analysis")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/v1/network-settings/sentiment-analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": false,\n \"monthlyQuota\": 10000,\n \"profiles\": [\n {\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyBackstory\": \"<string>\",\n \"topics\": [\n {\n \"name\": \"<string>\"\n }\n ]\n }\n ],\n \"customPost\": {\n \"enabled\": false,\n \"dataTypeAllowlist\": [],\n \"minTextComments\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"analyticConfigs": {
"sentimentAnalysisSetting": {
"enabled": false,
"monthlyQuota": 10000,
"profiles": [
{
"name": "<string>",
"companyName": "<string>",
"companyBackstory": "<string>",
"topics": [
{
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
],
"customPost": {
"enabled": false,
"dataTypeAllowlist": [],
"minTextComments": 10,
"effectiveAt": "2023-11-07T05:31:56Z"
}
}
}
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Authorizations
Body
application/json
sentiment analysis configuration for the network. Unknown keys inside customPost are
rejected rather than dropped, so the server-stamped effectiveAt cannot be supplied.
Number of contents that may be analysed each month.
Required range:
x >= 1Minimum array length:
1Show child attributes
Show child attributes
Extends sentiment analysis to custom post types. It applies only while sentiment analysis itself is enabled.
Show child attributes
Show child attributes
Response
Analytic configuration, carrying the updated sentiment analysis settings
Show child attributes
Show child attributes