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

# List events

> Each event has a deterministic one-line `title`, an AI `summary` (or null), a `significance` (0–1) and a typed
`payload`. Only changes that reach the watch's `settings.significance` become events. To poll, pass
`since=` the `created_at` of the newest event you already handled (or remember its id and stop paging there).




## OpenAPI

````yaml openapi.json GET /events
openapi: 3.1.0
info:
  title: AppGoat API
  version: 1.0.0
  summary: App Store + Google Play data for agents and apps.
  description: >
    Every app and developer in both stores, daily top charts, reviews, change
    feeds, metric history and keyword

    (search-rank) intelligence.


    **Conventions**

    - `{app}` accepts anything that identifies an app: an App Store id
    (`284882215`, `id284882215`), a Play
      package (`com.spotify.music`), an Apple bundle id (`com.spotify.client`), a store URL, `apple:<id>` /
      `play:<id>`, or a name (`spotify` → best match, with a warning in `meta.warnings`). Add `store=apple|play`
      to disambiguate. `data.linked` is the same app in the other store when we know it.
    - Freshness is automatic: app-scoped reads refresh data older than `max_age`
    seconds from the store first
      (1 credit per country fetched, capped at 10). `wait=true` (default) blocks up to ~25 s; on timeout, or with
      `wait=false`, you get the cached data with `meta.freshness.refreshing: true` and a `job_id` to poll at
      `GET /v1/jobs/{id}` (free).
    - `country` defaults to `us`; pass a comma list (paid plans) or `all`
    (Studio).

    - `include=` adds sections, `fields=` keeps only the listed top-level
    fields, lists page with `cursor`
      (pass `meta.next_cursor` back unchanged).
    - Every success is `{ data, meta }`; `meta.credits_used` is what the call
    cost and `meta.credits_remaining`
      what is left. Errors are `{ error: { code, message, hint, docs } }`: read `hint`, it says what to do next.
    - `x-credits` on each operation documents its price.

    - Watches turn store changes into events: `POST /v1/watches`, then poll `GET
    /v1/events` or add a webhook
      (`POST /v1/webhooks`). Watches, events and webhooks are free; only the plan's watched-app and keyword-slot
      limits apply. `/v1/tracked-keywords` is deprecated: use keyword watches.
  contact:
    email: support@appgoat.ai
    url: https://appgoat.ai
servers:
  - url: https://api.appgoat.ai/v1
security:
  - apiKey: []
tags:
  - name: Apps
  - name: Search & charts
  - name: Keywords
  - name: Developers
  - name: Audits
  - name: Watches & events
    description: >-
      Watch apps, competitors and keywords; significant changes become events
      (feed, webhooks, Slack, GitHub, daily email digest).
  - name: Webhooks
  - name: Connections
  - name: Actions
  - name: Jobs
  - name: Account
paths:
  /events:
    get:
      tags:
        - Watches & events
      summary: >-
        List significant changes on your watched apps and keywords, newest first
        (free; poll this to wake an agent).
      description: >
        Each event has a deterministic one-line `title`, an AI `summary` (or
        null), a `significance` (0–1) and a typed

        `payload`. Only changes that reach the watch's `settings.significance`
        become events. To poll, pass

        `since=` the `created_at` of the newest event you already handled (or
        remember its id and stop paging there).
      operationId: listEvents
      parameters:
        - name: type
          in: query
          description: Comma list of event types.
          schema:
            type: string
            example: new_version,rating_drop
        - name: app
          in: query
          description: Only events of this app (any `{app}` input).
          schema:
            type: string
        - $ref: '#/components/parameters/StoreHint'
        - name: watch
          in: query
          description: Only events of this watch id.
          schema:
            type: integer
        - $ref: '#/components/parameters/Since'
        - name: min_significance
          in: query
          schema:
            type: number
            minimum: 0
            maximum: 1
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: Events.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Event'
        '400':
          $ref: '#/components/responses/InvalidParam'
components:
  parameters:
    StoreHint:
      name: store
      in: query
      description: Disambiguates `{app}` (a bundle id vs a Play package, or a name).
      schema:
        $ref: '#/components/schemas/Store'
    Since:
      name: since
      in: query
      description: Only items at or after this ISO date / datetime.
      schema:
        type: string
        format: date-time
        example: '2026-10-01'
    Cursor:
      name: cursor
      in: query
      description: '`meta.next_cursor` from the previous page.'
      schema:
        type: string
  schemas:
    Envelope:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    Event:
      type: object
      description: >-
        Also the body of webhook deliveries and the GitHub `client_payload` (10
        top-level keys).
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/EventType'
        created_at:
          type: string
          format: date-time
        watch_id:
          type:
            - integer
            - 'null'
          description: null once the watch is deleted.
        app:
          oneOf:
            - type: object
              properties:
                store:
                  $ref: '#/components/schemas/Store'
                app_id:
                  type: string
                title:
                  type:
                    - string
                    - 'null'
                icon_url:
                  type:
                    - string
                    - 'null'
            - type: 'null'
        country:
          type:
            - string
            - 'null'
        title:
          type: string
          description: >-
            Deterministic one-liner, e.g. "Spotify released version 9.0.2 (was
            9.0.1)".
        summary:
          type:
            - string
            - 'null'
          description: >-
            AI one-line summary (null when AI is off or for low-significance
            events).
        significance:
          type:
            - number
            - 'null'
          minimum: 0
          maximum: 1
        payload:
          type: object
          description: >-
            Type-specific: version / release_notes, changes[{field, old, new}],
            rating / previous_rating / drop, keyword / rank / previous_rank,
            chart / category / rank, topic / sample…
      example:
        id: '4812'
        type: new_version
        created_at: '2026-10-22T08:15:02.000Z'
        watch_id: 12
        app:
          store: apple
          app_id: '324684580'
          title: Spotify
          icon_url: null
        country: us
        title: Spotify released version 9.0.2 (was 9.0.1)
        summary: Spotify 9.0.2 adds offline lyrics and fixes CarPlay crashes.
        significance: 0.81
        payload:
          version: 9.0.2
          previous_version: 9.0.1
          release_notes: Offline lyrics. CarPlay fixes.
    Store:
      type: string
      enum:
        - apple
        - play
    Meta:
      type: object
      properties:
        credits_used:
          type: integer
        credits_remaining:
          type: integer
          description: Added by the gateway.
        request_id:
          type: string
          description: Added by the gateway.
        freshness:
          $ref: '#/components/schemas/Freshness'
        next_cursor:
          type:
            - string
            - 'null'
        store:
          $ref: '#/components/schemas/Store'
        warnings:
          type: array
          items:
            type: string
          description: Things to know (e.g. "resolved by name"); safe to show to the user.
    EventType:
      type: string
      enum:
        - new_version
        - metadata_change
        - price_change
        - featured
        - in_app_event
        - installs_milestone
        - rating_drop
        - ratings_spike
        - review_spike
        - negative_review_spike
        - chart_enter
        - chart_leave
        - rank_change
        - keyword_entrant
      description: >
        App / competitor_set watches: `new_version` (version + release notes),
        `metadata_change` (title, subtitle,

        description, screenshots, icon, category…; `payload.changes`),
        `price_change` (price or in-app purchases),

        `featured` (Editors' Choice, featuring, badges), `in_app_event`,
        `installs_milestone` (Play install bucket),

        `rating_drop` (7-day drop ≥ settings.rating_drop), `ratings_spike` /
        `review_spike` (day count ≥

        settings.spike_factor × the 14-day average), `negative_review_spike`
        (negative reviews per topic),

        `chart_enter` / `chart_leave` (crossing the top settings.chart_top_n).
        Keyword watches: `rank_change` (the

        watch's app moved ≥ settings.rank_move, or entered / left the ranking),
        `keyword_entrant` (new apps in the

        top settings.keyword_top_n).
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_param
                - invalid_credentials
                - unauthorized
                - forbidden
                - insufficient_credits
                - plan_limit
                - free_audit_used
                - not_found
                - app_not_found
                - developer_not_found
                - job_not_found
                - conflict
                - not_ready
                - rate_limited
                - provider_error
                - internal_error
                - not_configured
            message:
              type: string
            hint:
              type: string
              description: What to do next.
            docs:
              type: string
              format: uri
            param:
              type: string
    Freshness:
      type: object
      properties:
        fetched_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the oldest requested country was last fetched from the store.
        age_seconds:
          type:
            - integer
            - 'null'
        stale:
          type: boolean
          description: Older than max_age (or missing).
        refreshing:
          type: boolean
          description: A store fetch is still running; poll job_id.
        job_id:
          type:
            - string
            - 'null'
  responses:
    InvalidParam:
      description: A parameter is missing or invalid (`error.param` names it).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_param
              message: limit must be ≤ 100
              hint: Fix the parameter and retry.
              docs: https://appgoat.ai/docs/errors#invalid_param
              param: limit
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Create a key at https://dash.appgoat.ai.

````

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