Amply API

openapi: 3.1.0
info:
  title: Amply API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 7 operation(s) read from 10 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Amply has published no machine-readable contract that the pipeline
    could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 1
    documentation: 6
    pages-with-code: 2
    pages-read: 10
  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://docs.amply.tools/reference/api-reference
  - https://docs.amply.tools/reference/api-reference.md
  - https://www.exchangerate-api.com/docs/historical-data-requests
  - https://www.exchangerate-api.com/docs/authentication
  - https://www.exchangerate-api.com/docs/standard-requests
  - https://www.exchangerate-api.com/docs/pair-conversion-requests
  - https://www.exchangerate-api.com/docs/enriched-data-requests
  - https://www.exchangerate-api.com/docs/supported-codes-endpoint
  - https://www.exchangerate-api.com/docs/request-quota-endpoint
  - https://www.exchangerate-api.com/docs/free
servers:
- url: https://api.amply.tools
paths:
  /api/v1/attribution:
    post:
      operationId: post_api_v1_attribution
      tags:
      - Api
      summary: Report install-attribution data from third-party attribution providers.
      description: Report install-attribution data from third‑party attribution providers.
      x-source: https://docs.amply.tools/reference/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AttributionRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/session:
    post:
      operationId: post_api_v1_session
      tags:
      - Api
      summary: Report sessions, events, and user/device state.
      description: Reports one or more sessions along with their events. This is the endpoint the SDK calls when it flushes its queue.
      x-source: https://docs.amply.tools/reference/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1SessionRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/tm/apple:
    post:
      operationId: post_api_v1_tm_apple
      tags:
      - Api
      summary: Report Apple App Store in-app purchase transactions.
      description: Reports Apple App Store in‑app purchase transactions for a device. Send one request per batch of transactions.
      x-source: https://docs.amply.tools/reference/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1TmAppleRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v6/{apiKey}/codes:
    get:
      operationId: get_v6_apiKey_codes
      tags:
      - Codes
      summary: Lists the currencies that we support.
      description: Returns a JSON array of all currently supported currencies.
      x-source: https://www.exchangerate-api.com/docs/supported-codes-endpoint
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV6ApikeyCodesResponse'
      x-evidence:
        kind: documentation
  /v6/{apiKey}/latest/USD:
    get:
      operationId: get_v6_apiKey_latest_USD
      tags:
      - Latest
      summary: Our default authentication scheme is to simply include your API key in the URL that you send a GET request to.
      x-source: https://www.exchangerate-api.com/docs/authentication
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v6/{apiKey}/quota:
    get:
      operationId: get_v6_apiKey_quota
      tags:
      - Quota
      summary: Documentation for the API Request Quota ExchangeRate-API endpoint.
      description: Returns a JSON formatted response showing the plan's quota level and remaining requests for the current period.
      x-source: https://www.exchangerate-api.com/docs/request-quota-endpoint
      parameters:
      - name: apiKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV6ApikeyQuotaResponse'
      x-evidence:
        kind: documentation
  /v6/latest/USD:
    get:
      operationId: get_v6_latest_USD
      tags:
      - Latest
      summary: GET /v6/latest/USD
      x-source: https://www.exchangerate-api.com/docs/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl. \n The disadvantage is that your API key can get included in logging as a result of being contained in the URL. Considering\
          \ that our service doesn't store any user data and the keys' purpose is just access control & rate limiting most users are OK with this\
          \ security tradeoff. \n \U0001F510 Token Bearer Authentication \n For customers that are more concerned about this logging risk or have\
          \ to meet audit "
components:
  schemas:
    PostApiV1AttributionRequest:
      type: object
      properties:
        device:
          type: object
          description: Device identity. id is required; external_id is optional.
        system:
          type: object
          description: Device system information. Must include os_version.
        attribution:
          type: object
          description: Container for per‑provider payloads. Unused providers may be omitted or sent as {}.
      required:
      - device
      - system
      - attribution
    PostApiV1SessionRequest:
      type: object
      properties:
        user:
          type: object
          description: User identity and custom properties.
        device:
          type: object
          description: Device identity and collected device properties.
        sessions:
          type: array
          description: One or more session records. Must contain at least one entry.
      required:
      - user
      - device
      - sessions
    PostApiV1TmAppleRequest:
      type: object
      properties:
        device:
          type: object
          description: Device identity. id required; external_id optional.
        transactions:
          type: array
          description: One entry per transaction. Must contain at least one item.
      required:
      - device
      - transactions
    GetV6ApikeyCodesResponse:
      type: object
      properties:
        result:
          type: string
          description: Result status, e.g., "success"
        documentation:
          type: string
          description: URL to the API documentation
        terms_of_use:
          type: string
          description: URL to the terms of use
        supported_codes:
          type: array
          description: Array of [currency code, currency name] pairs
    GetV6ApikeyQuotaResponse:
      type: object
      properties:
        result:
          type: string
          description: Indicates success or error.
        documentation:
          type: string
          description: URL to the API documentation.
        terms_of_use:
          type: string
          description: URL to the terms of use.
        plan_quota:
          type: integer
          description: Total number of requests allowed per month for the plan.
        requests_remaining:
          type: integer
          description: Number of requests left in the current period.
        refresh_day_of_month:
          type: integer
          description: Day of the month when the quota resets.
        error-type:
          type: string
          description: Error code when result is "error" (e.g., "invalid-key", "inactive-account", "quota-reached").
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
security:
- apiKey: []
tags:
- name: Api
- name: Codes
- name: Latest
- name: Quota