---
title: "Query Sentiment V2"
method: POST
path: "/v1/reports/sentiment-v2"
tags: ["Reports", "Reports"]
---

# Query Sentiment V2

`POST /v1/reports/sentiment-v2`

## Request body

- SentimentV2ReportQuery
  - `category_id` string, uuid, required
  - `asset_name` string, required
  - `start_date` string, date-time, required — Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
  - `end_date` string, date-time, required — End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
  - `comparison_start_date` string, date-time, nullable — Start of the previous period for delta computation.
  - `comparison_end_date` string, date-time, nullable — End of the previous period for delta computation.
  - `date_interval` 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'relative_week' — Date interval for the report. Only used when dimensions includes date.
  - `dimensions` string[] — Dimensions to group the report by.
  - `metrics` string[], required
  - `filters` union[] — List of filters to apply to the sentiment-v2 report.
    - union
      - SentimentV2ModelIdFilter
        - `field` 'model_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2RegionIdFilter
        - `field` 'region_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2TopicIdFilter
        - `field` 'topic_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2PromptIdFilter
        - `field` 'prompt_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2PersonaIdFilter
        - `field` 'persona_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2TagIdFilter
        - `field` 'tag_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2RunIdFilter
        - `field` 'run_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2ThemeIdFilter
        - `field` 'theme_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2ThemeFilter
        - `field` 'theme', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', required
        - `value` union, required
          - string
          - string[]
      - SentimentV2ClaimIdFilter
        - `field` 'claim_id', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - string, uuid
          - string[]
      - SentimentV2ClaimFilter
        - `field` 'claim', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', required
        - `value` union, required
          - string
          - string[]
      - SentimentV2SentimentFilter
        - `field` 'sentiment', required
        - `operator` 'is' | 'not_is' | 'in' | 'not_in', required
        - `value` union, required
          - 'positive' | 'negative'
          - string[]
  - `order_by` object — Custom ordering of report results. Dimension keys must also be present in dimensions. The sentiment metric orders by positive_sentiment.
  - `pagination` Pagination — Offset-based pagination parameters.
    - `limit` integer — Maximum number of results to return. Default is 10,000, maximum is 50,000.
    - `offset` integer — Offset for the results. Used for pagination.

## Response `200`

Successful Response

- SentimentV2ReportResponse
  - `info` SentimentV2ReportInfo, required
    - `query` object, required
    - `total_rows` integer, required
  - `data` SentimentDataPoint[]
    - `scores` SentimentPeriodScores, required
      - `current` SentimentScores
        - `positive_sentiment` number, required
        - `negative_sentiment` number, required
        - `assessment_count` integer, required
        - `occurrence` number, nullable
        - `response_count` integer, nullable
        - `total_response_count` integer, nullable
      - `previous` SentimentScores
        - `positive_sentiment` number, required
        - `negative_sentiment` number, required
        - `assessment_count` integer, required
        - `occurrence` number, nullable
        - `response_count` integer, nullable
        - `total_response_count` integer, nullable
    - `date` string, nullable
    - `prev_date` string, nullable
    - `group_ids` object, nullable
    - `group_names` object, nullable
    - `group_metadata` SentimentGroupMetadata
      - `theme_id` string, nullable
      - `theme` string, nullable
      - `claim_id` string, nullable
      - `claim` string, nullable
      - `sentiment` 'positive' | 'negative', nullable
      - `prompt_id` string, nullable
      - `prompt_text` string, nullable
      - `topic_id` string, nullable
      - `run_id` string, nullable
      - `created_at` string, nullable
      - `model_id` string, nullable
      - `region_id` string, nullable
      - `persona_id` string, nullable
      - `asset_name` string, nullable
      - `child_count_total` integer, nullable
      - `child_count_matching` integer, nullable
      - `parent_matches_search` boolean, nullable
      - `child_matches_search` boolean, nullable
    - `cited_website_hrefs` string[]
    - `total_count` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/cooper-square-technologies/apis/external-api.md) · [All operations](https://skmtc.net/cooper-square-technologies/apis/external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cooper-square-technologies/external-api/versions/ab03b3c80494/schema)