Umami Shares API

openapi: 3.2.0
info:
  title: Umami Shares API
  version: 3.3.1
  license:
    identifier: MIT
    name: MIT
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Shares across 2 of this provider''s published API definitions: umami-openapi.json, umami-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{instance}
  description: Self-hosted Umami instance (paths begin with /api). Umami Cloud serves the same API at https://api.umami.is/v1 per docs.umami.is/docs/api.
  variables:
    instance:
      default: your-umami-instance.example.com
tags:
- name: Shares
paths:
  /api/share:
    post:
      description: Creates a named share for a website, board, link, or pixel with parameters and an optional custom slug.
      operationId: createShare
      requestBody:
        content:
          application/json:
            schema:
              properties:
                entityId:
                  description: ID of the resource being shared.
                  format: uuid
                  type: string
                name:
                  description: Display name of the resource.
                  maxLength: 200
                  type: string
                parameters:
                  additionalProperties: true
                  description: Configuration parameters for the resource.
                  type: object
                shareType:
                  description: Type of resource made available by the share.
                  type: integer
                slug:
                  description: URL slug used to access the resource.
                  maxLength: 100
                  type: string
              required:
              - entityId
              - shareType
              - name
              - parameters
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  createdAt:
                    description: Date and time the record was created.
                    format: date-time
                    type: string
                  entityId:
                    description: ID of the resource being shared.
                    type: string
                  id:
                    description: Unique identifier of the resource.
                    type: string
                  name:
                    description: Display name of the resource.
                    type: string
                  parameters:
                    anyOf:
                    - type: string
                    - type: number
                    - const: false
                    - const: true
                    - additionalProperties:
                        anyOf:
                        - type: string
                        - type: number
                        - const: false
                        - const: true
                        - {}
                        - properties:
                            length:
                              type: number
                          required:
                          - length
                          type: object
                      properties: {}
                      type: object
                    - properties:
                        length:
                          type: number
                      required:
                      - length
                      type: object
                    description: Configuration parameters for the resource.
                  shareType:
                    description: Type of resource made available by the share.
                    type: number
                  slug:
                    description: URL slug used to access the resource.
                    type: string
                  updatedAt:
                    description: Date and time the record was last updated.
                    format: date-time
                    type: string
                required:
                - id
                - createdAt
                - updatedAt
                - name
                - slug
                - parameters
                - entityId
                - shareType
                type: object
          description: The operation completed successfully.
        '400':
          content:
            application/json:
              example:
                error:
                  code: bad-request
                  message: Bad request.
                  status: 400
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Bad request.
        '401':
          content:
            application/json:
              example:
                error:
                  code: unauthorized
                  message: Unauthorized.
                  status: 401
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unauthorized.
      security:
      - bearerAuth: []
      summary: Create a share
      tags:
      - Shares
      x-umami-audience: public
      x-umami-contract: explicit
      x-umami-source: src/app/api/share/contract.generated.ts
  /api/share/{slug}:
    get:
      description: Resolves a public share slug and returns its resource references, parameters, and an access token scoped to the shared resources.
      operationId: getShareBySlug
      parameters:
      - description: URL slug used to access the resource.
        in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: {}
                properties: {}
                type: object
          description: The operation completed successfully.
        '404':
          content:
            application/json:
              example:
                error:
                  code: not-found
                  message: Not found.
                  status: 404
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Not found.
      security: []
      summary: Open a share by its slug
      tags:
      - Shares
      x-umami-audience: public
      x-umami-contract: explicit
      x-umami-source: src/app/api/share/[slug]/contract.generated.ts
  /api/share/id/{shareId}:
    delete:
      description: Deletes the specified share after checking permission to delete shares for its resource.
      operationId: deleteShare
      parameters:
      - description: Identifier used to access a shared resource.
        in: path
        name: shareId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  ok:
                    const: true
                    description: Whether the operation succeeded.
                required:
                - ok
                type: object
          description: The operation completed successfully.
        '401':
          content:
            application/json:
              example:
                error:
                  code: unauthorized
                  message: Unauthorized.
                  status: 401
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unauthorized.
      security:
      - bearerAuth: []
      summary: Delete a share
      tags:
      - Shares
      x-umami-audience: public
      x-umami-contract: explicit
      x-umami-source: src/app/api/share/id/[shareId]/contract.generated.ts
    get:
      description: Returns a share's configuration by its ID after checking access to the shared resource.
      operationId: getShare
      parameters:
      - description: Identifier used to access a shared resource.
        in: path
        name: shareId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  createdAt:
                    description: Date and time the record was created.
                    format: date-time
                    type: string
                  entityId:
                    description: ID of the resource being shared.
                    type: string
                  id:
                    description: Unique identifier of the resource.
                    type: string
                  name:
                    description: Display name of the resource.
                    type: string
                  parameters:
                    anyOf:
                    - type: string
                    - type: number
                    - const: false
                    - const: true
                    - additionalProperties:
                        anyOf:
                        - type: string
                        - type: number
                        - const: false
                        - const: true
                        - {}
                        - properties:
                            length:
                              type: number
                          required:
                          - length
                          type: object
                      properties: {}
                      type: object
                    - properties:
                        length:
                          type: number
                      required:
                      - length
                      type: object
                    description: Configuration parameters for the resource.
                  shareType:
                    description: Type of resource made available by the share.
                    type: number
                  slug:
                    description: URL slug used to access the resource.
                    type: string
                  updatedAt:
                    description: Date and time the record was last updated.
                    format: date-time
                    type: string
                required:
                - id
                - createdAt
                - updatedAt
                - name
                - slug
                - parameters
                - entityId
                - shareType
                type: object
          description: The operation completed successfully.
        '401':
          content:
            application/json:
              example:
                error:
                  code: unauthorized
                  message: Unauthorized.
                  status: 401
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unauthorized.
      security:
      - bearerAuth: []
      - shareContext: []
        shareToken: []
      summary: Get a share
      tags:
      - Shares
      x-umami-audience: public
      x-umami-contract: explicit
      x-umami-source: src/app/api/share/id/[shareId]/contract.generated.ts
    post:
      description: Updates the specified share's name, slug, and parameters.
      operationId: updateShare
      parameters:
      - description: Identifier used to access a shared resource.
        in: path
        name: shareId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  description: Display name of the resource.
                  maxLength: 200
                  type: string
                parameters:
                  additionalProperties: true
                  description: Configuration parameters for the resource.
                  type: object
                slug:
                  description: URL slug used to access the resource.
                  maxLength: 100
                  type: string
              required:
              - name
              - slug
              - parameters
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  createdAt:
                    description: Date and time the record was created.
                    format: date-time
                    type: string
                  entityId:
                    description: ID of the resource being shared.
                    type: string
                  id:
                    description: Unique identifier of the resource.
                    type: string
                  name:
                    description: Display name of the resource.
                    type: string
                  parameters:
                    anyOf:
                    - type: string
                    - type: number
                    - const: false
                    - const: true
                    - additionalProperties:
                        anyOf:
                        - type: string
                        - type: number
                        - const: false
                        - const: true
                        - {}
                        - properties:
                            length:
                              type: number
                          required:
                          - length
                          type: object
                      properties: {}
                      type: object
                    - properties:
                        length:
                          type: number
                      required:
                      - length
                      type: object
                    description: Configuration parameters for the resource.
                  shareType:
                    description: Type of resource made available by the share.
                    type: number
                  slug:
                    description: URL slug used to access the resource.
                    type: string
                  updatedAt:
                    description: Date and time the record was last updated.
                    format: date-time
                    type: string
                required:
                - id
                - createdAt
                - updatedAt
                - name
                - slug
                - parameters
                - entityId
                - shareType
                type: object
          description: The operation completed successfully.
        '400':
          content:
            application/json:
              example:
                error:
                  code: bad-request
                  message: Bad request.
                  status: 400
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Bad request.
        '401':
          content:
            application/json:
              example:
                error:
                  code: unauthorized
                  message: Unauthorized.
                  status: 401
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unauthorized.
        '404':
          content:
            application/json:
              example:
                error:
                  code: not-found
                  message: Not found.
                  status: 404
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Not found.
      security:
      - bearerAuth: []
      summary: Update a share
      tags:
      - Shares
      x-umami-audience: public
      x-umami-contract: explicit
      x-umami-source: src/app/api/share/id/[shareId]/contract.generated.ts
components:
  schemas:
    ApiError:
      additionalProperties: false
      description: Standard Umami API error response.
      properties:
        error:
          additionalProperties: {}
          description: Error details returned when the operation fails.
          properties:
            code:
              type: string
            message:
              description: Human-readable explanation of the result.
              type: string
            status:
              maximum: 9007199254740991
              minimum: -9007199254740991
              type: integer
          required:
          - message
          - code
          - status
          type: object
      required:
      - error
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only).
      scheme: bearer
      type: http
    shareContext:
      description: Required context header when authenticating with a share token.
      in: header
      name: x-umami-share-context
      type: apiKey
    shareToken:
      description: Signed token returned by a share endpoint.
      in: header
      name: x-umami-share-token
      type: apiKey
externalDocs:
  description: Umami API documentation
  url: https://docs.umami.is/docs/api
x-refined-from:
- umami-openapi.json
- umami-openapi.yml