ASO Atlas API

openapi: 3.1.0
info:
  title: ASO Atlas API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 10 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; ASO Atlas has published no machine-readable contract that the
    pipeline could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 2
    documentation: 8
    pages-with-code: 3
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: oss
  x-sources:
  - https://asoatlas.com/docs/feedback-api
  - https://asoatlas.com/docs/in-app-feedback
  - https://asoatlas.com/docs/analytics-setup
paths:
  /api/v1/events:
    get:
      operationId: get_api_v1_events
      tags:
      - Api
      summary: GET /api/v1/events
      x-source: https://asoatlas.com/docs/analytics-setup
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl example, each with your key filled in. Every version: \n keeps a random install id (in UserDefaults or app storage, not\
          \ the Keychain, so a reinstall is a new install) and sends app_open on launch and on return to the foreground; \n sends app_background\
          \ when the app goes to the background (on a Mac, when another app becomes active) and sends the queue right away; \n stores events on\
          \ disk, sends t"
  /api/v1/feedback:
    get:
      operationId: get_api_v1_feedback
      tags:
      - Api
      summary: GET /api/v1/feedback
      x-source: https://asoatlas.com/docs/feedback-api
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1FeedbackResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl) are on the setup page under Feedback . This page explains what those examples do, so you can adapt them or write your\
          \ own. \n Base URL and headers \n Every endpoint lives under: \n https://asoatlas.com/api/v1/feedback\n Header \n Sent on \n Value \n\
          \ X-Feedback-Key \n Every request \n Your publishable key ( fk_... ) from the setup page \n X-Feedback-Thread \n The /thread endpoints\
          \ \n The conversation tok"
  /conversations:
    get:
      operationId: get_conversations
      tags:
      - Conversations
      summary: List every conversation of a signed-in user across devices.
      description: Lists all conversations for a user after identity verification.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      - name: X-Feedback-User
        in: header
        required: true
        schema:
          type: string
        description: User id
      - name: X-Feedback-User-Hash
        in: header
        required: true
        schema:
          type: string
        description: HMAC‑SHA256 of user id
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConversationsResponse'
      x-evidence:
        kind: documentation
  /summaries:
    post:
      operationId: post_summaries
      tags:
      - Summaries
      summary: Get a list of conversation summaries with preview and unread count.
      description: Returns one row per conversation, newest activity first, with preview and unread count.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSummariesRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSummariesResponse'
      x-evidence:
        kind: documentation
  /thread:
    delete:
      operationId: delete_thread
      tags:
      - Thread
      summary: Delete the conversation with its files.
      description: Deletes the conversation and its attached files.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      - name: X-Feedback-Thread
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_thread
      tags:
      - Thread
      summary: Read and continue a conversation returns the thread without token and url.
      description: Returns the conversation data and marks replies as read.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      - name: X-Feedback-Thread
        in: header
        required: true
        schema:
          type: string
        description: Conversation token (ft_...)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetThreadResponse'
      x-evidence:
        kind: documentation
  /thread/messages:
    post:
      operationId: post_thread_messages
      tags:
      - Thread
      summary: Add a follow-up message to a conversation.
      description: Adds a follow‑up message, reopens a resolved conversation.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      - name: X-Feedback-Thread
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostThreadMessagesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostThreadMessagesResponse'
      x-evidence:
        kind: documentation
  /thread/review-clicked:
    post:
      operationId: post_thread_review_clicked
      tags:
      - Thread
      summary: Tell ASO Atlas the latest review request reached the user.
      description: Notifies that the review prompt was shown or the store link opened.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      - name: X-Feedback-Thread
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /threads:
    post:
      operationId: post_threads
      tags:
      - Threads
      summary: Create a conversation opens a conversation with its first message.
      description: Opens a conversation with its first message. Accepts JSON or multipart/form-data when attaching files.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
        description: Publishable key (fk_...)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostThreadsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostThreadsResponse'
      x-evidence:
        kind: documentation
  /unread:
    post:
      operationId: post_unread
      tags:
      - Unread
      summary: Get unread badge counts for stored conversation tokens.
      description: Returns unread reply count per conversation id for up to 50 tokens.
      x-source: https://asoatlas.com/docs/feedback-api
      parameters:
      - name: X-Feedback-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostUnreadRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostUnreadResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1FeedbackResponse:
      type: object
      properties:
        mode:
          type: string
        thread:
          type: object
          properties:
            id:
              type: integer
            status:
              type: string
            category:
              type: string
            created_at:
              type: string
              format: date-time
            app:
              type: object
              properties:
                name:
                  type: string
                icon_url:
                  type: string
            messages:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  author:
                    type: string
                  kind:
                    type: string
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  attachments:
                    type: array
                    items: {}
            unread_count:
              type: integer
            token:
              type: string
            url:
              type: string
    GetConversationsResponse:
      type: object
      properties:
        mode:
          type: string
        threads:
          type: object
          description: Array of conversation objects with token
    PostSummariesRequest:
      type: object
      properties:
        tokens:
          type: string
          description: Array of conversation tokens (ft_...)
      required:
      - tokens
    PostSummariesResponse:
      type: object
      properties:
        mode:
          type: string
        conversations:
          type: object
          description: Array of conversation summary objects
    GetThreadResponse:
      type: object
      properties:
        mode:
          type: string
        thread:
          type: object
    PostThreadMessagesRequest:
      type: object
      properties:
        message:
          type: string
          description: Message body
        attachments[]:
          type: string
          description: Files to attach
      required:
      - message
    PostThreadMessagesResponse:
      type: object
      properties:
        mode:
          type: string
        thread:
          type: object
    PostThreadsRequest:
      type: object
      properties:
        message:
          type: string
          description: Up to 10,000 characters
        category:
          type: string
          description: bug, idea, question, praise or other (default)
        email:
          type: string
          description: Developer contact email (never emailed by ASO Atlas)
        name:
          type: string
          description: Up to 120 characters
        install_id:
          type: string
          description: Random id per install, recommended
        external_user_id:
          type: string
          description: Your own user id
        user_hash:
          type: string
          description: Identity hash of external_user_id
        platform:
          type: string
          description: ios, macos, android, web or other
        app_version:
          type: string
          description: Up to 32 characters
        build:
          type: string
          description: Up to 32 characters
        os_version:
          type: string
          description: Up to 32 characters
        device_model:
          type: string
          description: Up to 64 characters
        locale:
          type: string
          description: User's preferred language tag, up to 16 characters
        attachments[]:
          type: string
          description: Files, see attachment rules
      required:
      - message
    PostThreadsResponse:
      type: object
      properties:
        mode:
          type: string
          description: conversation or collect
        thread:
          type: object
          description: Conversation object with id, status, etc.
    PostUnreadRequest:
      type: object
      properties:
        tokens:
          type: string
          description: Array of conversation tokens (ft_...)
      required:
      - tokens
    PostUnreadResponse:
      type: object
      properties:
        mode:
          type: string
        unread:
          type: object
          description: Mapping of conversation id to unread count
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Feedback-Key
security:
- apiKey: []
tags:
- name: Api
- name: Conversations
- name: Summaries
- name: Thread
- name: Threads
- name: Unread