> ## 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.

# List tone runs

> List entity-tone scoring runs. 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/entity-tone/runs
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/entity-tone/runs:
    get:
      tags:
        - Media Intelligence
      summary: List tone runs
      description: >-
        List entity-tone scoring runs. Requires a plan with Entity media tone
        access (`can_use_tone`) — the Analyst, Media Intelligence, Geopolitical
        Intelligence, and Global Intelligence plans.
      operationId: list-entity-tone-runs-v2
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 25
          description: Rows per page.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor (opaque offset).
      responses:
        '200':
          description: List tone runs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        run_id:
                          type: string
                        run_type:
                          type: string
                        status:
                          type: string
                        request_source:
                          type: string
                        requester_user_id:
                          type: string
                        requester_email:
                          type: string
                        request_json:
                          type: string
                        denominator_hash:
                          type: string
                        start_date:
                          type: string
                        end_date:
                          type: string
                        target_entity_count:
                          type: integer
                        candidate_story_count:
                          type: integer
                        scored_case_count:
                          type: integer
                        estimated_query_units:
                          type: integer
                        charged_query_units:
                          type: integer
                        estimated_cost_usd:
                          type: number
                        error:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor: {}
                      next_cursor: {}
                      has_more:
                        type: boolean
              examples:
                example:
                  summary: GET /api/v2/entity-tone/runs — example response
                  value:
                    success: true
                    data:
                      - run_id: entity-tone-v2-3f9c1b2a-7d4e-4a51-9c83-1e6b2f0a55d1
                        run_type: entity_tone
                        status: succeeded
                        request_source: api
                        requester_user_id: a1d4f7c2-9b3e-4c08-8f21-6d5b0e9a3c47
                        requester_email: ''
                        request_json: >-
                          {"entity_ids":["wikipedia:en:Saudi_Aramco"],"start_date":"2026-06-01","end_date":"2026-06-28","filters":{}}
                        denominator_hash: c0ffee7a1b2c3d4e
                        start_date: '2026-06-01'
                        end_date: '2026-06-28'
                        target_entity_count: 1
                        candidate_story_count: 213
                        scored_case_count: 188
                        estimated_query_units: 23
                        charged_query_units: 23
                        estimated_cost_usd: 0.1704
                        error: ''
                        created_at: '2026-06-28 14:22:07'
                        updated_at: '2026-06-28 14:41:55'
                      - run_id: entity-tone-v2-8b71e4d0-2a16-4f93-bc55-9aa0c7e21f08
                        run_type: entity_tone
                        status: queued
                        request_source: api
                        requester_user_id: a1d4f7c2-9b3e-4c08-8f21-6d5b0e9a3c47
                        requester_email: ''
                        request_json: >-
                          {"entity_ids":["wikipedia:en:Tesla,_Inc."],"start_date":"2026-06-20","end_date":"2026-06-28","filters":{}}
                        denominator_hash: 9a8b7c6d5e4f3021
                        start_date: '2026-06-20'
                        end_date: '2026-06-28'
                        target_entity_count: 1
                        candidate_story_count: 642
                        scored_case_count: 0
                        estimated_query_units: 66
                        charged_query_units: 0
                        estimated_cost_usd: 0.5136
                        error: ''
                        created_at: '2026-06-29 09:03:12'
                        updated_at: '2026-06-29 09:03:12'
                    pagination:
                      limit: 25
                      cursor: null
                      next_cursor: null
                      has_more: false
        '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_...`.'

````