Get Sentiment Report

curl --request POST \
  --url https://api.writesonic.com/v2/geo/reports/sentiments \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "project_id": "<string>",
  "dimensions": [],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "order_by": [
    {
      "field": "<string>"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0
  },
  "measures": [],
  "filters": {
    "topics": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "prompts": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "tags": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "markets": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "intent": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "branded": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "platform": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "has_shopping_card": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "has_ads_data": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "visibility": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "rank": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_answer": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "cited_page_url": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "cited_domain": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_citation": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "advanced_filters": {
      "join": "and",
      "conditions": [
        {
          "operator": "<string>",
          "value": "<unknown>"
        }
      ]
    },
    "status": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    }
  }
}
'

import requests

url = "https://api.writesonic.com/v2/geo/reports/sentiments"

payload = {
    "project_id": "<string>",
    "dimensions": [],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "order_by": [{ "field": "<string>" }],
    "pagination": {
        "limit": 10,
        "offset": 0
    },
    "measures": [],
    "filters": {
        "topics": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "prompts": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "tags": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "markets": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "intent": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "branded": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "platform": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "has_shopping_card": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "has_ads_data": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "visibility": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "rank": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "website_mentioned_in_answer": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "cited_page_url": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "cited_domain": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "website_mentioned_in_citation": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "advanced_filters": {
            "join": "and",
            "conditions": [
                {
                    "operator": "<string>",
                    "value": "<unknown>"
                }
            ]
        },
        "status": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        }
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    dimensions: [],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    order_by: [{field: '<string>'}],
    pagination: {limit: 10, offset: 0},
    measures: [],
    filters: {
      topics: {condition: 'AND', items: [{value: '<unknown>'}]},
      prompts: {condition: 'AND', items: [{value: '<unknown>'}]},
      tags: {condition: 'AND', items: [{value: '<unknown>'}]},
      markets: {condition: 'AND', items: [{value: '<unknown>'}]},
      intent: {condition: 'AND', items: [{value: '<unknown>'}]},
      branded: {condition: 'AND', items: [{value: '<unknown>'}]},
      platform: {condition: 'AND', items: [{value: '<unknown>'}]},
      has_shopping_card: {condition: 'AND', items: [{value: '<unknown>'}]},
      has_ads_data: {condition: 'AND', items: [{value: '<unknown>'}]},
      visibility: {condition: 'AND', items: [{value: '<unknown>'}]},
      rank: {condition: 'AND', items: [{value: '<unknown>'}]},
      website_mentioned_in_answer: {condition: 'AND', items: [{value: '<unknown>'}]},
      cited_page_url: {condition: 'AND', items: [{value: '<unknown>'}]},
      cited_domain: {condition: 'AND', items: [{value: '<unknown>'}]},
      website_mentioned_in_citation: {condition: 'AND', items: [{value: '<unknown>'}]},
      advanced_filters: {join: 'and', conditions: [{operator: '<string>', value: '<unknown>'}]},
      status: {condition: 'AND', items: [{value: '<unknown>'}]}
    }
  })
};

fetch('https://api.writesonic.com/v2/geo/reports/sentiments', 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://api.writesonic.com/v2/geo/reports/sentiments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'dimensions' => [
        
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'order_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'pagination' => [
        'limit' => 10,
        'offset' => 0
    ],
    'measures' => [
        
    ],
    'filters' => [
        'topics' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'prompts' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'tags' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'markets' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'intent' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'branded' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'platform' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'has_shopping_card' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'has_ads_data' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'visibility' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'rank' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'website_mentioned_in_answer' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'cited_page_url' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'cited_domain' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'website_mentioned_in_citation' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'advanced_filters' => [
                'join' => 'and',
                'conditions' => [
                                [
                                                                'operator' => '<string>',
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'status' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ]
    ]
  ]),
  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://api.writesonic.com/v2/geo/reports/sentiments"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.writesonic.com/v2/geo/reports/sentiments")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.writesonic.com/v2/geo/reports/sentiments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "query": {
      "metrics": [
        "<string>"
      ],
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "order_by": {},
      "pagination": {},
      "filters": {}
    }
  },
  "data": [
    {
      "topic_id": "<string>",
      "topic_name": "<string>",
      "tag_id": "<string>",
      "tag_name": "<string>",
      "market_id": "<string>",
      "market_name": "<string>",
      "model_id": "<string>",
      "model_name": "<string>",
      "query_id": "<string>",
      "query_name": "<string>",
      "date": "<string>",
      "website_id": "<string>",
      "website_name": "<string>",
      "shopping": true,
      "ads": true,
      "branded": true,
      "total_keyword_occurrences": 123,
      "total_positive_keyword_occurrences": 123,
      "unique_positive_keywords": 123,
      "total_unique_keywords": 123,
      "positive_subtheme_count": 123,
      "negative_subtheme_count": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Reports

Get Sentiment Report

Keyword sentiment metrics grouped by one or more dimensions.

Example: “Show positive keyword trends by topic, broken down monthly.”

Dimensions (at least 1 required): topic, tag, market, model, query, date, website

date supports optional date_aggregation_interval: day (default) | week | month
website auto-sets website_type to SELF+COMPETITORS (default is SELF)

Measures (omit for all): total_keyword_occurrences, total_positive_keyword_occurrences, unique_positive_keywords, total_unique_keywords

Filters: topics, prompts, tags, markets, intent, branded, platform, has_shopping_card, visibility, rank, website_mentioned_in_answer, cited_page_url, cited_domain, website_mentioned_in_citation, status.

Sort fields: Any measure name, plus date, query_name, topic_name, market_name, model_name, website_name, tag_name.

Dates: If no dates provided, defaults to latest run date range. Provide start_date and end_date in ISO 8601 format to specify a custom range.

Pagination: Use pagination (limit 1-100, default 10; offset for paging). Use order_by for sorting.

Response: Returns data array with info metadata containing total_rows (before pagination) and query (applied metrics, dates, sorting, pagination, filters).

POST

geo

reports

sentiments

Get Sentiment Report

curl --request POST \
  --url https://api.writesonic.com/v2/geo/reports/sentiments \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "project_id": "<string>",
  "dimensions": [],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "order_by": [
    {
      "field": "<string>"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0
  },
  "measures": [],
  "filters": {
    "topics": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "prompts": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "tags": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "markets": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "intent": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "branded": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "platform": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "has_shopping_card": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "has_ads_data": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "visibility": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "rank": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_answer": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "cited_page_url": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "cited_domain": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_citation": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    },
    "advanced_filters": {
      "join": "and",
      "conditions": [
        {
          "operator": "<string>",
          "value": "<unknown>"
        }
      ]
    },
    "status": {
      "condition": "AND",
      "items": [
        {
          "value": "<unknown>"
        }
      ]
    }
  }
}
'

import requests

url = "https://api.writesonic.com/v2/geo/reports/sentiments"

payload = {
    "project_id": "<string>",
    "dimensions": [],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "order_by": [{ "field": "<string>" }],
    "pagination": {
        "limit": 10,
        "offset": 0
    },
    "measures": [],
    "filters": {
        "topics": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "prompts": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "tags": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "markets": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "intent": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "branded": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "platform": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "has_shopping_card": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "has_ads_data": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "visibility": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "rank": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "website_mentioned_in_answer": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "cited_page_url": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "cited_domain": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "website_mentioned_in_citation": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        },
        "advanced_filters": {
            "join": "and",
            "conditions": [
                {
                    "operator": "<string>",
                    "value": "<unknown>"
                }
            ]
        },
        "status": {
            "condition": "AND",
            "items": [{ "value": "<unknown>" }]
        }
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    dimensions: [],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    order_by: [{field: '<string>'}],
    pagination: {limit: 10, offset: 0},
    measures: [],
    filters: {
      topics: {condition: 'AND', items: [{value: '<unknown>'}]},
      prompts: {condition: 'AND', items: [{value: '<unknown>'}]},
      tags: {condition: 'AND', items: [{value: '<unknown>'}]},
      markets: {condition: 'AND', items: [{value: '<unknown>'}]},
      intent: {condition: 'AND', items: [{value: '<unknown>'}]},
      branded: {condition: 'AND', items: [{value: '<unknown>'}]},
      platform: {condition: 'AND', items: [{value: '<unknown>'}]},
      has_shopping_card: {condition: 'AND', items: [{value: '<unknown>'}]},
      has_ads_data: {condition: 'AND', items: [{value: '<unknown>'}]},
      visibility: {condition: 'AND', items: [{value: '<unknown>'}]},
      rank: {condition: 'AND', items: [{value: '<unknown>'}]},
      website_mentioned_in_answer: {condition: 'AND', items: [{value: '<unknown>'}]},
      cited_page_url: {condition: 'AND', items: [{value: '<unknown>'}]},
      cited_domain: {condition: 'AND', items: [{value: '<unknown>'}]},
      website_mentioned_in_citation: {condition: 'AND', items: [{value: '<unknown>'}]},
      advanced_filters: {join: 'and', conditions: [{operator: '<string>', value: '<unknown>'}]},
      status: {condition: 'AND', items: [{value: '<unknown>'}]}
    }
  })
};

fetch('https://api.writesonic.com/v2/geo/reports/sentiments', 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://api.writesonic.com/v2/geo/reports/sentiments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'dimensions' => [
        
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'order_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'pagination' => [
        'limit' => 10,
        'offset' => 0
    ],
    'measures' => [
        
    ],
    'filters' => [
        'topics' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'prompts' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'tags' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'markets' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'intent' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'branded' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'platform' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'has_shopping_card' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'has_ads_data' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'visibility' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'rank' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'website_mentioned_in_answer' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'cited_page_url' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'cited_domain' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'website_mentioned_in_citation' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'advanced_filters' => [
                'join' => 'and',
                'conditions' => [
                                [
                                                                'operator' => '<string>',
                                                                'value' => '<unknown>'
                                ]
                ]
        ],
        'status' => [
                'condition' => 'AND',
                'items' => [
                                [
                                                                'value' => '<unknown>'
                                ]
                ]
        ]
    ]
  ]),
  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://api.writesonic.com/v2/geo/reports/sentiments"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.writesonic.com/v2/geo/reports/sentiments")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.writesonic.com/v2/geo/reports/sentiments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"dimensions\": [],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"order_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"limit\": 10,\n    \"offset\": 0\n  },\n  \"measures\": [],\n  \"filters\": {\n    \"topics\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"prompts\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"tags\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"markets\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"intent\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"branded\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"platform\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_shopping_card\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"has_ads_data\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"visibility\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"rank\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_answer\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_page_url\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"cited_domain\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"website_mentioned_in_citation\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"advanced_filters\": {\n      \"join\": \"and\",\n      \"conditions\": [\n        {\n          \"operator\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ]\n    },\n    \"status\": {\n      \"condition\": \"AND\",\n      \"items\": [\n        {\n          \"value\": \"<unknown>\"\n        }\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "query": {
      "metrics": [
        "<string>"
      ],
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "order_by": {},
      "pagination": {},
      "filters": {}
    }
  },
  "data": [
    {
      "topic_id": "<string>",
      "topic_name": "<string>",
      "tag_id": "<string>",
      "tag_name": "<string>",
      "market_id": "<string>",
      "market_name": "<string>",
      "model_id": "<string>",
      "model_name": "<string>",
      "query_id": "<string>",
      "query_name": "<string>",
      "date": "<string>",
      "website_id": "<string>",
      "website_name": "<string>",
      "shopping": true,
      "ads": true,
      "branded": true,
      "total_keyword_occurrences": 123,
      "total_positive_keyword_occurrences": 123,
      "unique_positive_keywords": 123,
      "total_unique_keywords": 123,
      "positive_subtheme_count": 123,
      "negative_subtheme_count": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Request parameters for the Sentiment Report API.

project_id

string

required

Unique identifier of the project to query. Get valid project IDs from get_all_projects.

Minimum string length: 1

Example:

"550e8400-e29b-41d4-a716-446655440000"

dimensions

enum<string>[]

required

Dimensions to group sentiment data by. At least one dimension is required.

Minimum array length: 1

Dimensions to group report data by.

topic: Group by topic/category
tag: Group by tag
market: Group by market/region
model: Group by AI model (e.g. ChatGPT, Perplexity)
query: Group by individual query/prompt
date: Group by date (requires date_aggregation_interval)
website: Group by tracked website
shopping: Group by whether the response has a shopping card (true/false)
ads: Group by whether the response has sponsored/ad placements (true/false)
branded: Group by whether the underlying query is branded (true/false)

Available options:

topic,

tag,

market,

model,

query,

date,

website,

shopping,

ads,

branded

Examples:

["topic", "model"]

["market", "date"]

start_date

string<date-time>

Start of the date range (ISO 8601). Limits results to data collected on or after this date. When omitted: defaults to the latest run's start date for metric queries, or earliest available date for list queries.

Examples:

"2026-01-01T00:00:00Z"

"2026-03-01T00:00:00Z"

end_date

string<date-time>

End of the date range (ISO 8601). Limits results to data collected on or before this date. When omitted: defaults to today. Date-only strings (no 'T') are extended to end of day.

Examples:

"2026-01-31T23:59:59Z"

"2026-03-17T23:59:59Z"

order_by

SortingOrder · object[]

Sort results by one or more fields. Each entry specifies a field name and direction. Results are sorted by the first entry, then ties broken by subsequent entries.

Show child attributes

Examples:

[
  {
    "field": "visibility_score",
    "order": "desc"
  }
]

[
  { "field": "mention_count", "order": "desc" },
  { "field": "rank", "order": "asc" }
]

pagination

PaginationInput · object

Control result pagination. Set limit for page size and offset to skip results. Omit to return all results (use with caution on large datasets).

Show child attributes

Examples:

{ "limit": 10, "offset": 0 }

{ "limit": 25, "offset": 50 }

measures

enum<string>[]

Sentiment metrics to include. If empty, all measures are returned.

Sentiment metrics to include in the report.

total_keyword_occurrences: Total occurrences of tracked keywords
total_positive_keyword_occurrences: Occurrences of positive sentiment keywords
unique_positive_keywords: Count of distinct positive keywords found
total_unique_keywords: Count of all distinct keywords found
positive_subtheme_count: Count of subthemes classified as positive (majority-vote: positive keyword hits >= negative hits)
negative_subtheme_count: Count of subthemes classified as negative (majority-vote: negative keyword hits > positive hits)

Available options:

total_keyword_occurrences,

total_positive_keyword_occurrences,

unique_positive_keywords,

total_unique_keywords,

positive_subtheme_count,

negative_subtheme_count

Example:

[
  "total_keyword_occurrences",
  "unique_positive_keywords"
]

filters

SentimentFiltersInput · object

Narrow results by topics, markets, platforms, etc. All filters are optional and combine with AND logic.

Show child attributes

date_aggregation_interval

enum<string>

Optional. When using the 'date' dimension, controls time-series bucket size. Defaults to 'day' if omitted. Options: day, week, month.

Available options:

day,

week,

month

Examples:

"week"

"day"

website_type

enum<string>

Scope results by website ownership. 'SELF' = your brand only, 'SELF+COMPETITORS' = your brand plus competitors, 'ALL' = all citations without domain filtering.

Available options:

SELF,

SELF+COMPETITORS,

ALL

Example:

"SELF"

Response

Successful Response

Response containing sentiment report data.

info

ResponseInfo · object

Information of the API request including total count and query details

Show child attributes

data

SentimentDataRow · object[]

Array of sentiment data rows grouped by the requested dimensions

Show child attributes

Get Citation Report

⌘I