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

# GetIntelTimeline

> GetIntelTimeline returns the durable historical intelligence store
 newest-first for one domain and/or country. Pure index read — no
 embedding, no ranking. Premium-gated. PRO-gated. Requires entitlement tier >= 1.



## OpenAPI

````yaml /api/IntelligenceService.openapi.yaml get /api/intelligence/v1/get-intel-timeline
openapi: 3.1.0
info:
  title: IntelligenceService API
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/intelligence/v1/get-intel-timeline:
    get:
      tags:
        - IntelligenceService
      summary: GetIntelTimeline
      description: |-
        GetIntelTimeline returns the durable historical intelligence store
         newest-first for one domain and/or country. Pure index read — no
         embedding, no ranking. Premium-gated. PRO-gated. Requires entitlement tier >= 1.
      operationId: GetIntelTimeline
      parameters:
        - name: domain
          in: query
          description: Restrict to one producing domain. Required unless `country` is set.
          required: false
          example: conflict
          schema:
            type: string
            pattern: ^(conflict|military|energy)?$
        - name: country
          in: query
          description: >-
            Restrict to one ISO 3166-1 alpha-2 country. Required unless `domain`
            is
             set. Supplying both narrows to their intersection.
          required: false
          example: US
          schema:
            type: string
            pattern: ^([A-Z]{2})?$
        - name: from
          in: query
          description: |-
            Earliest occurred_at to return, Unix epoch milliseconds, inclusive.
             0 or omitted means no lower bound.
          required: false
          example: '1717200000000'
          schema:
            type: string
            format: int64
        - name: to
          in: query
          description: |-
            Latest occurred_at to return, Unix epoch milliseconds, inclusive.
             0 or omitted means no upper bound.
          required: false
          example: '1717200000000'
          schema:
            type: string
            format: int64
        - name: limit
          in: query
          description: |-
            Maximum events to return. Defaults to 50 server-side when omitted or
             <= 0; the handler caps it at 200, the TIMELINE_MAX_LIMIT the Convex
             query clamps to (convex/intelHistory.ts).
          required: false
          example: 25
          schema:
            type: integer
            format: int32
        - name: jmespath
          in: query
          description: >-
            Optional JMESPath expression applied server-side to project or
            reduce the JSON response before it is returned (mirrors the MCP
            jmespath argument). Invalid expressions, expressions larger than
            1024 UTF-8 bytes, or projections that exceed the 256 KB output cap
            return HTTP 400 with a {_jmespath_error, original_keys} envelope.
            Grammar and worked examples:
            https://www.worldmonitor.app/docs/mcp-jmespath.
          required: false
          example: keys(@)
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                partial: true
                records:
                  - category: cs.AI
                    country: US
                    domain: example
                    id: example-id
                    ingestedAt: 1717200000000
                upstreamUnavailable: true
              schema:
                $ref: '#/components/schemas/GetIntelTimelineResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/JmespathProjectionError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: PRO entitlement access denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '429':
          description: Rate limit exceeded.
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Remaining:
              description: Requests remaining in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Reset:
              description: >-
                Unix epoch milliseconds when the active rate-limit window
                resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/RateLimitError'
        default:
          description: Gateway or handler error response.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/GatewayError'
      security:
        - WorldMonitorKey: []
        - ApiKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    GetIntelTimelineResponse:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/IntelHistoryRecord'
        partial:
          type: boolean
          description: >-
            True when the bounded post-filter candidate window may omit older
            events.
        upstreamUnavailable:
          type: boolean
          description: >-
            True when the history store could not be reached. The gateway reads
            this
             flag out of the body and switches the response to Cache-Control:
             no-store, so a transient outage is never pinned as a false-empty timeline
             for the tier's full TTL.
      description: GetIntelTimelineResponse returns the scoped history newest-first.
    ValidationError:
      type: object
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/FieldViolation'
          description: List of validation violations
      required:
        - violations
      description: >-
        ValidationError is returned when request validation fails. It contains a
        list of field violations describing what went wrong.
    JmespathProjectionError:
      description: >-
        Returned when a REST jmespath projection is invalid or exceeds the
        expression/output byte limits.
      properties:
        _jmespath_error:
          description: Projection error discriminator and details.
          type: string
        original_keys:
          description: Top-level keys or shape of the unprojected response.
          items:
            type: string
          type: array
      required:
        - _jmespath_error
        - original_keys
      type: object
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
      description: >-
        Returned when the API key is missing, malformed, or lacks current API
        access.
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable entitlement failure reason.
        requiredTier:
          type: integer
          format: int32
          description: Minimum entitlement tier required for this endpoint.
        currentTier:
          type: integer
          format: int32
          description: Caller entitlement tier when known.
        planKey:
          type: string
          description: Caller plan key when known.
      required:
        - error
      description: >-
        Returned when a PRO-gated endpoint denies access because the caller has
        no resolved authenticated user, entitlements cannot be verified, or the
        caller lacks the required entitlement tier.
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message (e.g., 'user not found', 'database connection failed')
      description: >-
        Error is returned when a handler encounters an error. It contains a
        simple error message that the developer can customize.
    RateLimitError:
      type: object
      description: Returned when a gateway or handler rate limit rejects the request.
      properties:
        error:
          type: string
          description: Human-readable rate-limit failure reason.
      required:
        - error
    GatewayError:
      type: object
      description: >-
        Returned by gateway infrastructure errors before an RPC handler runs,
        such as origin, routing, method, authentication, or quota checks.
      properties:
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: Gateway error reason or structured gateway failure details.
      required:
        - error
    IntelHistoryRecord:
      type: object
      properties:
        id:
          type: string
          description: >-
            Opaque stable handle for the stored event (a Convex document id).
            Useful
             for de-duplicating across calls; not resolvable through any public route.
        domain:
          type: string
          description: |-
            Producing domain, e.g. "conflict", "military", "energy". Matches the
             domain filter accepted by the three RPCs.
        resource:
          type: string
          description: |-
            Seeder-level resource that produced the event, e.g. "acled-events".
             Finer-grained than domain and not part of any request filter.
        country:
          type: string
          description: >-
            ISO 3166-1 alpha-2 country code. Empty when the event is not
            attributable
             to a single country.
        category:
          type: string
          description: >-
            Producer-supplied event category, e.g. "battle". Free-form per
            domain;
             empty when the producer did not classify the event.
        title:
          type: string
          description: Event headline. Always present.
        summary:
          type: string
          description: Longer description. Empty when the producer had none.
        sourceUrl:
          type: string
          description: >-
            Canonical link to the underlying report. Empty when the producer had
            none.
        occurredAt:
          type: integer
          format: int64
          description: >-
            When the event happened, Unix epoch milliseconds. This is the field
            the
             timeline orders by and the from/to filters bound.. Warning: Values > 2^53 may lose precision in JavaScript
        ingestedAt:
          type: integer
          format: int64
          description: >-
            When WorldMonitor stored the event, Unix epoch milliseconds.
            Distinct from
             occurred_at for backfills, and the field retention ages rows out by.. Warning: Values > 2^53 may lose precision in JavaScript
        score:
          type: number
          format: double
          description: >-
            Cosine similarity against the request's query vector, in [-1, 1].
            Higher
             is closer. Always 0 on GetIntelTimeline, which ranks by time and has no
             query vector to score against.
      description: |-
        IntelHistoryRecord is one durable historical intelligence event (#5694).

         Seeders append the events they publish to the Convex `intelHistory` table
         (convex/intelHistory.ts) after each run; every read path — chronological
         (GetIntelTimeline) and semantic (SearchIntelHistory, GetSimilarEvents) —
         returns this same projection, so a caller can hold one record shape.

         Defined in its own file because all three RPCs reuse it, matching the
         satellite.proto convention.
    FieldViolation:
      type: object
      properties:
        field:
          type: string
          description: >-
            The field path that failed validation (e.g., 'user.email' for nested
            fields). For header validation, this will be the header name (e.g.,
            'X-API-Key')
        description:
          type: string
          description: >-
            Human-readable description of the validation violation (e.g., 'must
            be a valid email address', 'required field missing')
      required:
        - field
        - description
      description: FieldViolation describes a single validation error for a specific field.
  securitySchemes:
    WorldMonitorKey:
      type: apiKey
      in: header
      name: X-WorldMonitor-Key
      description: User-issued WorldMonitor API key.
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key).
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: a Clerk-issued JWT for browser session flows, passed as
        Authorization: Bearer <token>.

````