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

# Save a query

> Saves validated filters and a fixed or rolling UTC time specification. Private by default; workspace sharing uses the authenticated current workspace. Authentication fields, results and pagination are not supported. Do not put secrets in query text.



## OpenAPI

````yaml /api-reference/openapi-v2.json post /api/v2/saved-queries
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: Situations
    description: >-
      One real-world occurrence as the Stories and coded Events that belong to
      it — stored, adjudicated membership (`meta.situation_source: curated`) or
      a walked neighbourhood around a Story. Discovery, detail, four
      independently paged member lists, and the only write on the core surface
      (5 QU with an Idempotency-Key).
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone. Also the publication activity journal
      (/api/v2/activity): observed evidence of what was published about
      identities and records — committed batches only, cursor-paged, never
      source intake.
  - name: Unified Search
    description: >-
      One fuzzy lookup across every id-space — start here with a name, take the
      entity id, then reuse it on every other surface. This is the resolver the
      rest of the API assumes you called first.
  - name: Media Intelligence
    description: >-
      Press-coverage tone over time and share of voice against a peer set.
      Requires the `can_use_tone` / `can_use_share_of_voice` entitlement; social
      signal is an admin-only preview.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets, World Port Index
      ports and Epoch AI data centers on one keyed surface, resolved to spine
      owners. Requires the `can_use_facilities` entitlement.
  - name: Monitors
    description: >-
      Organization-shared scheduled checks over the Core API, with email and
      signed-webhook delivery. Monitor execution does not consume query units.
  - name: Saved Queries
    description: >-
      Reusable validated query recipes with private or explicit workspace
      sharing.
  - name: Geography
    description: >-
      Country context and admin-1 geography: /api/v2/countries (publication
      activity, reporting counts, dated economic and resource fundamentals,
      facility and office inventories, directory mode over every registered
      country) and admin-1 lookups.
  - name: Government
    description: >-
      US federal awards (USAspending) and foreign-influence registrations (DOJ
      NSD FARA), resolved onto the entity spine. Requires the `can_use_gov`
      entitlement.
  - name: Political Offices
    description: >-
      Public political offices and who holds them — legislatures, cabinets,
      heads of state, courts and IGO posts, with the office start/end dates the
      publisher states (valid time), resolved onto the entity spine. Actor
      context for geopolitical analysis; NOT a PEP or sanctions-screening tool.
      Requires the `can_use_offices` entitlement.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and relations extracted from filing
      text. Requires the `can_use_filings` entitlement.
  - name: Reference Data
    description: >-
      The GLEIF Global LEI Index — legal-entity reference data, consolidation
      relationships, and LEI↔ISIN mappings. Requires the `can_use_gleif`
      entitlement.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: AI Compute
    description: >-
      Epoch AI datasets — models, hardware, data centers, companies and chip
      sales. Requires the `can_use_epoch_ai` entitlement.
  - name: Macro Finance
    description: >-
      FRED economic time series — catalog, point-in-time observations and
      releases. Requires the `can_use_macro` entitlement.
  - name: Screening and Reference
    description: >-
      Restricted-party lists, name screening and ownership-chain exposure.
      Requires the `can_use_screening` / `can_use_exposure` entitlement.
      Analytical coverage, not an audit-grade compliance control.
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Requires the
      `can_use_china` entitlement.
  - name: Maritime
    description: >-
      AIS-derived vessel flow — chokepoint transits, last-known vessel
      positions, carriers, dwell and AIS-dark gaps. Terrestrial AIS only, so
      coverage thins in open ocean. Requires the `can_use_maritime` entitlement.
  - name: Atlas Intelligence
    description: >-
      Geopolitical-risk and posture indices computed from GDELT Cloud’s own
      coded events, normalized to each place’s own frozen baseline.
  - name: Natural Resources
    description: >-
      USGS mineral production, reserves and qualified country statistics,
      composed with the physical Facilities inventory.
  - name: Briefs
    description: Source-backed monitoring briefs.
  - name: Meta
    description: >-
      Machine-readable discovery: the value vocabularies, the endpoint
      contracts, and the query-unit cost model. Unmetered, so a client can check
      before it spends.
paths:
  /api/v2/saved-queries:
    post:
      tags:
        - Saved Queries
      summary: Save a query
      description: >-
        Saves validated filters and a fixed or rolling UTC time specification.
        Private by default; workspace sharing uses the authenticated current
        workspace. Authentication fields, results and pagination are not
        supported. Do not put secrets in query text.
      operationId: create-saved-query-v2
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SavedQueryInput'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedQueryResponse'
        '400':
          description: Invalid or unsupported parameter (see `code` and `details`)
        '401':
          description: Missing or invalid API key
        '403':
          description: Plan does not include this surface
        '404':
          description: Not found
        '429':
          description: Quota or rate limit exceeded
        '500':
          description: Server error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SavedQueryInput:
      type: object
      properties:
        title:
          type: string
        endpoint_family:
          type: string
          enum:
            - events
            - stories
            - entities
            - facilities
            - countries
            - search
            - filings
            - workspace
        params:
          type: object
          additionalProperties:
            type: string
        time_spec:
          oneOf:
            - type: object
              properties:
                mode:
                  type: string
                  enum:
                    - none
              required:
                - mode
            - type: object
              properties:
                mode:
                  type: string
                  enum:
                    - rolling
                days:
                  type: number
                timezone:
                  type: string
                  enum:
                    - UTC
                  default: UTC
              required:
                - mode
                - days
            - type: object
              properties:
                mode:
                  type: string
                  enum:
                    - fixed
                date_start:
                  type: string
                date_end:
                  type: string
              required:
                - mode
                - date_start
                - date_end
        display:
          type: object
          properties:
            sort:
              type: string
            limit:
              type: number
            include_images:
              type: boolean
            include_entity_images:
              type: boolean
          default: {}
        visibility:
          type: string
          enum:
            - private
            - workspace
          default: private
        pinned:
          type: boolean
          default: false
        contract_version:
          oneOf:
            - type: number
              enum:
                - 1
            - type: number
              enum:
                - 2
          default: 1
        investigation:
          type: object
          properties:
            workflow:
              type: string
              enum:
                - company
                - minerals
                - compute
                - ports
                - energy
                - places
                - officials
            target:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                reporting:
                  type: object
                  properties:
                    lane:
                      type: string
                      enum:
                        - events
                        - stories
                    params:
                      type: object
                      additionalProperties:
                        type: string
                  required:
                    - lane
                    - params
              required:
                - id
                - name
            sections:
              type: array
              items:
                type: string
                enum:
                  - reporting
                  - facilities
                  - filings
                  - participants
                  - observations
              maxItems: 5
          required:
            - workflow
            - target
            - sections
          nullable: true
        request:
          type: object
          properties:
            tool:
              type: string
              enum:
                - unified-search
                - entity-detail
                - facilities
                - facilities-detail
                - facility-relationships
                - facility-observations
                - facility-context
                - stories
                - events
                - filings
          required:
            - tool
          nullable: true
      required:
        - title
        - endpoint_family
        - params
        - time_spec
    SavedQueryResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: object
          properties:
            title:
              type: string
            endpoint_family:
              type: string
              enum:
                - events
                - stories
                - entities
                - facilities
                - countries
                - search
                - filings
                - workspace
            params:
              type: object
              additionalProperties:
                type: string
            time_spec:
              oneOf:
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - none
                  required:
                    - mode
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - rolling
                    days:
                      type: number
                    timezone:
                      type: string
                      enum:
                        - UTC
                      default: UTC
                  required:
                    - mode
                    - days
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - fixed
                    date_start:
                      type: string
                    date_end:
                      type: string
                  required:
                    - mode
                    - date_start
                    - date_end
            display:
              type: object
              properties:
                sort:
                  type: string
                limit:
                  type: number
                include_images:
                  type: boolean
                include_entity_images:
                  type: boolean
              default: {}
            visibility:
              type: string
              enum:
                - private
                - workspace
              default: private
            pinned:
              type: boolean
              default: false
            contract_version:
              oneOf:
                - type: number
                  enum:
                    - 1
                - type: number
                  enum:
                    - 2
              default: 1
            investigation:
              type: object
              properties:
                workflow:
                  type: string
                  enum:
                    - company
                    - minerals
                    - compute
                    - ports
                    - energy
                    - places
                    - officials
                target:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    reporting:
                      type: object
                      properties:
                        lane:
                          type: string
                          enum:
                            - events
                            - stories
                        params:
                          type: object
                          additionalProperties:
                            type: string
                      required:
                        - lane
                        - params
                  required:
                    - id
                    - name
                sections:
                  type: array
                  items:
                    type: string
                    enum:
                      - reporting
                      - facilities
                      - filings
                      - participants
                      - observations
                  maxItems: 5
              required:
                - workflow
                - target
                - sections
              nullable: true
            request:
              type: object
              properties:
                tool:
                  type: string
                  enum:
                    - unified-search
                    - entity-detail
                    - facilities
                    - facilities-detail
                    - facility-relationships
                    - facility-observations
                    - facility-context
                    - stories
                    - events
                    - filings
              required:
                - tool
              nullable: true
            id:
              type: string
            user_id:
              type: string
            org_id:
              type: string
              nullable: true
            created_at:
              type: string
            updated_at:
              type: string
            last_opened_at:
              type: string
              nullable: true
          required:
            - title
            - endpoint_family
            - params
            - time_spec
            - id
            - user_id
            - org_id
            - created_at
            - updated_at
            - last_opened_at
        can_edit:
          type: boolean
        href:
          type: string
          nullable: true
        incompatibility:
          type: string
          nullable: true
      required:
        - success
        - data
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.