> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gdeltcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Entity tone (by entity)

> Media tone toward a specific entity over a date window, with optional cited evidence. Requires a plan with Entity media tone access (`can_use_tone`) — the Analyst, Media Intelligence, Geopolitical Intelligence, and Global Intelligence plans.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/entities/{entity_id}/tone
openapi: 3.0.3
info:
  title: GDELT Cloud API v2
  version: 2.0.0
  description: >-
    Clean v2 REST API for generated GDELT Cloud structured Events, clustered
    Stories, linked Entities, summaries, admin1 discovery, significance ranking,
    and paginated article evidence.


    Event significance is a family-scoped weighted blend, renormalized so every
    event family spans a true 0-1: each event's raw total is divided by the
    maximum its own family can reach (Conflict 1.00, CAMEO+ POLITICAL 0.90,
    other CAMEO+ domains 0.65). All events: Goldstein severity 0.25, article
    evidence 0.05, confidence 0.05. Conflict only: fatalities 0.55 (log-scaled
    by body count) and civilian targeting 0.10. CAMEO+ only: magnitude 0.20,
    systemic importance 0.15, propagation potential 0.10, market sensitivity
    0.10. When magnitude is unmeasured its term AND its 0.20 weight are both
    dropped. The four CAMEO+ metrics are rubric scores produced by published
    formulas - ordinal ranking signals, not measurements, probabilities, or
    predicted price moves. goldstein_scale is one canonical public metric,
    populated for Conflict Events and CAMEO+ POLITICAL Events where meaningful.
    Story linked_event_count is a Story-to-Event link aggregate, not a distinct
    Event total.
servers:
  - url: https://gdeltcloud.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: Events
    description: Coded CAMEO+ / conflict events — search, fetch, and summarize.
  - name: Stories
    description: Clustered narratives (stories) and their articles.
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone.
  - name: Geography
    description: Admin-1 geography lookups.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets + World Port Index
      ports + Epoch AI data centers on one keyed surface, resolved to spine
      owners. Plan-gated (Analyst plan and up).
  - name: Screening and Reference
    description: >-
      Restricted-party lists, screening, and ownership-chain exposure.
      Plan-gated (`can_use_screening` / `can_use_exposure`).
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Plan-gated
      (`can_use_china`).
  - name: Media Intelligence
    description: >-
      Entity tone (`can_use_tone`) and Share of Voice (`can_use_share_of_voice`)
      are plan-gated. Social signal remains an admin-only preview.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and AI-extracted relations. Requires a
      plan with SEC filings access (`can_use_filings`) — the Corporate & Supply
      Chain plan and above.
  - name: Macro Finance
    description: >-
      FRED economic time series (catalog, point-in-time observations, releases).
      Plan-gated (`can_use_macro`).
  - name: Maritime
    description: >-
      AIS-derived vessel-flow signals across maritime chokepoints — chokepoint
      transits, last-known vessel positions, carriers, dwell, and AIS-dark gaps.
      Plan-gated (`can_use_maritime`).
  - name: Briefs
    description: Source-backed monitoring briefs.
paths:
  /api/v2/entities/{entity_id}/tone:
    get:
      tags:
        - Entities
      summary: Entity tone (by entity)
      description: >-
        Media tone toward a specific entity over a date window, with optional
        cited evidence. Requires a plan with Entity media tone access
        (`can_use_tone`) — the Analyst, Media Intelligence, Geopolitical
        Intelligence, and Global Intelligence plans.
      operationId: get-entity-tone-v2
      parameters:
        - name: entity_id
          in: path
          required: true
          schema:
            type: string
          description: Canonical entity id or wikipedia_url.
        - name: date_start
          in: query
          required: false
          schema:
            type: string
          description: Window start YYYY-MM-DD (≤30-day window).
        - name: date_end
          in: query
          required: false
          schema:
            type: string
          description: Window end YYYY-MM-DD.
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 30
          description: Trailing N-day window (1–30).
        - name: languages
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated language filter (e.g. en,zh). Accepted codes:
            [Taxonomy & Codes — Languages](/api-reference/taxonomy#languages).
        - name: group_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - language
          description: >-
            group_by=language returns a per-language tone breakdown over ALL
            scored Stories in the window — on each
            entity_coverage[].by_language: mean_tone, mean_risk, confidence,
            scored_story_count (scored Stories covered in that language),
            article_count (total articles in that language, real coverage volume
            — not the evidence sample), and a per-language daily series. Use it
            to compare how the entity is covered across languages.
        - name: include_evidence
          in: query
          required: false
          schema:
            type: boolean
          description: Return cited evidence snippets.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 25
          description: Max rows.
        - name: bucket
          in: query
          required: false
          description: >-
            Time bucket for the tone series. See [Taxonomy & Codes — Media
            Intelligence](/api-reference/taxonomy#media-intelligence).
          schema:
            type: string
            enum:
              - day
              - week
              - month
            default: day
        - name: quality
          in: query
          required: false
          description: Evidence-gating quality tier for which tone rows to return.
          schema:
            type: string
            enum:
              - production_ready
              - reviewable
              - all
            default: production_ready
        - name: min_confidence
          in: query
          required: false
          description: Minimum per-bucket tone confidence to include (0–1).
          schema:
            type: number
            minimum: 0
            maximum: 1
      responses:
        '200':
          description: Entity tone (by entity).
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  start_date:
                    type: string
                  end_date:
                    type: string
                  entities:
                    type: array
                    items:
                      type: string
                  resolved_entities:
                    type: array
                    items:
                      type: object
                      properties:
                        input:
                          type: string
                        canonical_entity_id:
                          type: string
                        display_name:
                          type: string
                        entity_type:
                          type: string
                        wikipedia_url:
                          type: string
                        match_type:
                          type: string
                  unresolved_terms:
                    type: array
                    items: {}
                  entity_coverage:
                    type: array
                    items:
                      type: object
                      properties:
                        canonical_entity_id:
                          type: string
                        display_name:
                          type: string
                        entity_type:
                          type: string
                        wikipedia_url:
                          type: string
                        tone_status:
                          type: string
                        row_count:
                          type: integer
                        candidate_story_count:
                          type: integer
                        candidate_article_count:
                          type: integer
                        candidate_mention_count:
                          type: integer
                        scored_story_count:
                          type: integer
                  rows:
                    type: array
                    items:
                      type: object
                      properties:
                        canonical_entity_id:
                          type: string
                        display_name:
                          type: string
                        entity_type:
                          type: string
                        bucket_date:
                          type: string
                        bucket_granularity:
                          type: string
                        denominator_hash:
                          type: string
                        candidate_story_count:
                          type: integer
                        scored_story_count:
                          type: integer
                        scored_article_count:
                          type: integer
                        insufficient_evidence_count:
                          type: integer
                        needs_review_count:
                          type: integer
                        avg_tone_score:
                          type: number
                        avg_risk_score:
                          type: number
                        avg_confidence:
                          type: number
                        coverage_ratio:
                          type: number
                        agreement_score:
                          type: number
                        languages:
                          type: array
                          items:
                            type: string
                        top_positive_story_ids:
                          type: array
                          items:
                            type: string
                        top_negative_story_ids:
                          type: array
                          items: {}
                        top_risky_story_ids:
                          type: array
                          items:
                            type: string
                  methodology:
                    type: object
                    properties:
                      unit:
                        type: string
                      tone_score:
                        type: string
                      risk_score:
                        type: string
                      missing_tone:
                        type: string
              examples:
                example:
                  summary: GET /api/v2/entities/{entity_id}/tone — example response
                  value:
                    status: available
                    start_date: '2026-06-01'
                    end_date: '2026-06-28'
                    entities:
                      - wikipedia:en:Saudi_Aramco
                    resolved_entities:
                      - input: Saudi Aramco
                        canonical_entity_id: wikipedia:en:Saudi_Aramco
                        display_name: Saudi Aramco
                        entity_type: organization
                        wikipedia_url: https://en.wikipedia.org/wiki/Saudi_Aramco
                        match_type: exact_alias
                    unresolved_terms: []
                    entity_coverage:
                      - canonical_entity_id: wikipedia:en:Saudi_Aramco
                        display_name: Saudi Aramco
                        entity_type: organization
                        wikipedia_url: https://en.wikipedia.org/wiki/Saudi_Aramco
                        tone_status: scored
                        row_count: 28
                        candidate_story_count: 213
                        candidate_article_count: 1486
                        candidate_mention_count: 2741
                        scored_story_count: 188
                    rows:
                      - canonical_entity_id: wikipedia:en:Saudi_Aramco
                        display_name: Saudi Aramco
                        entity_type: organization
                        bucket_date: '2026-06-14'
                        bucket_granularity: day
                        denominator_hash: ''
                        candidate_story_count: 12
                        scored_story_count: 11
                        scored_article_count: 86
                        insufficient_evidence_count: 1
                        needs_review_count: 0
                        avg_tone_score: 9.6
                        avg_risk_score: 25.1
                        avg_confidence: 0.83
                        coverage_ratio: 0.91
                        agreement_score: 0.77
                        languages:
                          - en
                          - ar
                        top_positive_story_ids:
                          - 20260614-aramco-upstream-expansion
                        top_negative_story_ids: []
                        top_risky_story_ids:
                          - 20260614-aramco-pipeline-incident
                      - canonical_entity_id: wikipedia:en:Saudi_Aramco
                        display_name: Saudi Aramco
                        entity_type: organization
                        bucket_date: '2026-06-15'
                        bucket_granularity: day
                        denominator_hash: ''
                        candidate_story_count: 17
                        scored_story_count: 15
                        scored_article_count: 112
                        insufficient_evidence_count: 1
                        needs_review_count: 1
                        avg_tone_score: 12.4
                        avg_risk_score: 28.7
                        avg_confidence: 0.81
                        coverage_ratio: 0.88
                        agreement_score: 0.74
                        languages:
                          - en
                          - ar
                          - fr
                        top_positive_story_ids:
                          - 20260615-aramco-dividend-raise
                          - 20260615-aramco-lng-deal
                        top_negative_story_ids:
                          - 20260615-aramco-emissions-report
                        top_risky_story_ids:
                          - 20260615-aramco-emissions-report
                    methodology:
                      unit: entity-story rollups over article-entity evidence
                      tone_score: >-
                        -100..100 media tone toward the entity; not direct
                        public opinion
                      risk_score: >-
                        0..100 reputational or issue-risk severity, separate
                        from tone direction
                      missing_tone: >-
                        missing or insufficient evidence is unavailable, not
                        neutral
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Plan required (PLAN_REQUIRED) — the caller's plan does not carry the
            required source entitlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        code:
          type: string
        details:
          type: object
          description: >-
            Recoverable validation context when available, such as param,
            invalid_value, accepted_values, nearest_values, and a corrected
            example.
          additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````