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

# Get app insights

> Built from the AI tags on every review (sentiment, intent, severity, topic). `top_issues` are topics carried
by negative / bug / crash / UX / pricing reviews, with `last_30d` vs `prev_30d` counts and sample reviews;
`versions` shows what each release changed in sentiment and topics; `sentiment_over_time` is weekly. Use it
for "what do users complain about since v2.3?" or a reviews → GitHub issues playbook. Reviews not tagged yet
only count in the totals (`tagged` < `reviews`, see `meta.warnings`).




## OpenAPI

````yaml openapi.json GET /apps/{app}/insights
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:
  /apps/{app}/insights:
    get:
      tags:
        - Apps
      summary: >-
        Review intelligence for an app - top issues with trends and samples,
        topics per version, weekly sentiment.
      description: >
        Built from the AI tags on every review (sentiment, intent, severity,
        topic). `top_issues` are topics carried

        by negative / bug / crash / UX / pricing reviews, with `last_30d` vs
        `prev_30d` counts and sample reviews;

        `versions` shows what each release changed in sentiment and topics;
        `sentiment_over_time` is weekly. Use it

        for "what do users complain about since v2.3?" or a reviews → GitHub
        issues playbook. Reviews not tagged yet

        only count in the totals (`tagged` < `reviews`, see `meta.warnings`).
      operationId: getAppInsights
      parameters:
        - $ref: '#/components/parameters/App'
        - $ref: '#/components/parameters/StoreHint'
        - name: country
          in: query
          description: One storefront; omit for every storefront we hold reviews for.
          schema:
            type: string
        - name: since_days
          in: query
          schema:
            type: integer
            minimum: 7
            maximum: 730
            default: 180
        - name: versions
          in: query
          description: How many of the latest versions to break down.
          schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 6
      responses:
        '200':
          description: Insights.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        $ref: '#/components/schemas/Insights'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          $ref: '#/components/responses/AppNotFound'
components:
  parameters:
    App:
      name: app
      in: path
      required: true
      description: >-
        Any app identifier: App Store id (`284882215`, `id284882215`), Play
        package (`com.spotify.music`), Apple bundle id (`com.spotify.client`),
        store URL (URL-encoded), `apple:<id>` / `play:<id>`, or a name
        (`spotify`).
      schema:
        type: string
        example: com.spotify.music
    StoreHint:
      name: store
      in: query
      description: Disambiguates `{app}` (a bundle id vs a Play package, or a name).
      schema:
        $ref: '#/components/schemas/Store'
  schemas:
    Envelope:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    Insights:
      type: object
      properties:
        window:
          type: object
          properties:
            since:
              type: string
              format: date-time
            until:
              type: string
              format: date-time
        reviews:
          type: integer
        tagged:
          type: integer
          description: Reviews with AI tags (the breakdowns below cover these).
        avg_rating:
          type:
            - number
            - 'null'
        sentiment:
          type: object
          properties:
            positive:
              type: integer
            neutral:
              type: integer
            negative:
              type: integer
        intents:
          type: object
          additionalProperties:
            type: integer
        topics:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              reviews:
                type: integer
              negative:
                type: integer
              avg_rating:
                type:
                  - number
                  - 'null'
        top_issues:
          type: array
          items:
            type: object
            properties:
              topic:
                type: string
              reviews:
                type: integer
              share:
                type: number
              avg_severity:
                type:
                  - number
                  - 'null'
                description: 0 none - 3 critical.
              intents:
                type: object
                additionalProperties:
                  type: integer
              last_30d:
                type: integer
              prev_30d:
                type: integer
              versions:
                type: array
                items:
                  type: string
              samples:
                type: array
                items:
                  type: object
                  properties:
                    rating:
                      type:
                        - integer
                        - 'null'
                    version:
                      type:
                        - string
                        - 'null'
                    created_at:
                      type: string
                    text:
                      type: string
        versions:
          type: array
          items:
            type: object
            properties:
              version:
                type: string
              first_review_at:
                type: string
                format: date-time
              reviews:
                type: integer
              avg_rating:
                type:
                  - number
                  - 'null'
              sentiment:
                type: object
                additionalProperties:
                  type: integer
              intents:
                type: object
                additionalProperties:
                  type: integer
              topics:
                type: array
                items:
                  type: object
                  additionalProperties: true
        sentiment_over_time:
          type: array
          items:
            type: object
            properties:
              week:
                type: string
                format: date
              reviews:
                type: integer
              positive:
                type: integer
              neutral:
                type: integer
              negative:
                type: integer
              avg_rating:
                type:
                  - number
                  - 'null'
    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.
    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:
    PaymentRequired:
      description: >-
        `insufficient_credits` (the call costs more than you have left; nothing
        was done) or `plan_limit` (a feature of a higher plan).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AppNotFound:
      description: Nothing matches `{app}`, or the store does not have it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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.