openapi: 3.2.0
info:
  version: 1.1.0
  title: LiveLike Analytics Collections API
  description: Access the data behind your LiveLike dashboards. Contact your LiveLike account manager to get your API key.
servers:
- url: https://metabase.livelikecdn.com
  description: LiveLike Metabase instance
security:
- ApiKeyAuth: []
tags:
- name: Collections
  description: Your collection is the folder LiveLike has set up for you. It contains all your reports and dashboards.
  x-readme-tag-description: Your collection is the folder LiveLike has set up for you. It contains all your reports and dashboards.
paths:
  /api/collection/:
    get:
      tags:
      - Collections
      summary: List All Collections
      description: 'Lists all collections your API key has access to. Use the `id` from your collection in the next step to list your reports.


        > The root collection has `id: "root"`. Your collection will have an integer ID.'
      operationId: get_collections
      responses:
        '200':
          description: A flat array of Collections visible to your API key.
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Collection'
              examples:
                OK:
                  summary: Client collection
                  value:
                  - id: root
                    name: Our analytics
                    description: null
                  - id: 1405
                    name: Serie A
                    description: null
        '401':
          description: Unauthorized — `x-api-key` header is missing or invalid.
  /api/collection/{collection_id}/items:
    get:
      tags:
      - Collections
      summary: List Collection Items
      description: Lists the reports (Cards) and dashboards inside your collection. Use the `id` from any Card to download its data.
      operationId: get_collection_items
      parameters:
      - in: path
        name: collection_id
        required: true
        schema: {}
        description: An integer Collection ID from `GET /api/collection/` or `GET /api/collection/tree`. Don't pass the string `"root"` here — you need an actual integer ID.
      - in: query
        name: models
        required: false
        schema:
          enum:
          - card
          - dashboard
          - document
        description: 'Filter by item type. Repeat to include multiple: `?models=card&models=dashboard`. Leave it out to get everything.'
      - in: query
        name: limit
        required: false
        schema:
          minimum: 1
          default: 50
        description: Max items per page. Defaults to 50.
      - in: query
        name: offset
        required: false
        schema:
          minimum: 0
          default: 0
        description: 'Where to start in the list (zero-based). Use with `limit` to page through: second page = `offset=50`, third = `offset=100`, and so on.'
      responses:
        '200':
          description: A paginated list of items in the Collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionItemsResponse'
              examples:
                OK:
                  summary: Cards and a dashboard in a collection
                  value:
                    total: 3
                    data:
                    - id: 3267
                      name: Daily KPIs - Unique Users & Impressions
                      model: card
                      description: Daily aggregated KPIs
                    - id: 3268
                      name: Widget Engagement
                      model: card
                      description: null
                    - id: 343
                      name: Serie A Overview
                      model: dashboard
                      description: null
        '401':
          description: Unauthorized — `x-api-key` header is missing or invalid.
        '403':
          description: Forbidden — your API key doesn't have access to this Collection.
        '404':
          description: Collection not found.
components:
  schemas:
    CollectionItemsResponse:
      type: object
      description: The list of reports and dashboards in your collection.
      properties:
        total:
          type:
          - integer
          - 'null'
          description: Total number of items.
        data:
          type: array
          description: Your reports and dashboards.
          items:
            $ref: '#/components/schemas/CollectionItem'
    CollectionItem:
      type: object
      description: A report (Card) or dashboard inside your collection.
      properties:
        id:
          type: integer
          description: Report or dashboard ID. Use this to download data or get more details.
        name:
          type: string
          description: Report or dashboard name.
        model:
          type: string
          enum:
          - card
          - dashboard
          - document
          description: '`"card"` = a report you can download, `"dashboard"` = a dashboard.'
        description:
          type:
          - string
          - 'null'
          description: What this report covers.
    Collection:
      type: object
      description: A collection (folder) containing your reports and dashboards.
      properties:
        id:
          oneOf:
          - type: integer
          - type: string
          description: Collection ID. Use this in `GET /api/collection/{id}/items` to list your reports.
        name:
          type: string
          description: Collection name.
        description:
          type:
          - string
          - 'null'
          description: Optional description.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key. Contact your LiveLike account manager to get one.
x-tagGroups:
- name: API Reference
  tags:
  - Collections
  - Cards
  - Dashboards
x-provenance:
  method: searched
  source: https://docs.livelike.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.livelike.com/reference/get_card.md
  - https://docs.livelike.com/reference/get_collection_items.md
  - https://docs.livelike.com/reference/get_collections.md
  - https://docs.livelike.com/reference/get_dashboard.md
  - https://docs.livelike.com/reference/post_card_query_export.md
  - https://docs.livelike.com/reference/post_dashboard_card_query_export.md
  merge:
    pages: 6
    deduped: 11
    conflicts_kept_first: 0