---
agentTools:
  projectIndex: https://zencity-apis.readme.io/llms.txt
---

# Sentiment analysis: Overview

# Description

![](https://files.readme.io/889a91fa4f812a5f92bedb7a6df2d6b2944d1b119d2fba7ab72bfce846e8d5c5-image.png)

<br />

Returns the data as classified by positive or negative sentiment.

Note 1: Fields “dateFrom” and “dateTo” are obligatory.

Note 2: You will get the interaction counter itself, not the percentage.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "platform",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.zencity.io/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://example.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/categoryScore/presets/v1/getSentimentOverview": {
      "get": {
        "summary": "Sentiment analysis: Overview",
        "description": "",
        "operationId": "sentiment-analysis-overview-1",
        "parameters": [
          {
            "name": "token",
            "in": "header",
            "description": "Auth token",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dateFrom",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "dateTo",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "dateRange",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "day",
                "week",
                "month"
              ]
            }
          },
          {
            "name": "sentiment",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "positive",
                "negative",
                "neutral"
              ]
            }
          },
          {
            "name": "project",
            "in": "query",
            "description": "An Id of a project",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dataSourceOfficial",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "locationSubTerritory",
            "in": "query",
            "description": "An Id of a subTerritory",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "description": "A key of a category",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "categoryGroup",
            "in": "query",
            "description": "A key of a category group",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "65f31292a83c5d00105a69bd:6888bd3045e5230eb7d8f8c0"
}
```