OpenPanel API

naftiko: 1.0.0-alpha2
info:
  label: OpenPanel API
  description: OpenPanel API API capability.
  tags:
  - Openpanel
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: openpanel
    baseUri: https://api.example.com
    description: OpenPanel API HTTP API.
    resources:
    - name: event
      path: /event/
      operations:
      - name: post-event
        method: POST
        description: Deprecated direct event ingestion endpoint. Use /track instead.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profile
      path: /profile/
      operations:
      - name: post-profile
        method: POST
        description: Identify or update a user profile.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profile-increment
      path: /profile/increment
      operations:
      - name: post-profile-increment
        method: POST
        description: Increment a numeric property on a user profile.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profile-decrement
      path: /profile/decrement
      operations:
      - name: post-profile-decrement
        method: POST
        description: Decrement a numeric property on a user profile.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: export-events
      path: /export/events
      operations:
      - name: get-export-events
        method: GET
        description: Export a paginated list of raw events with optional filtering by date, profile, and event type.
        inputParameters:
        - name: project_id
          in: query
          type: string
        - name: projectId
          in: query
          type: string
        - name: profileId
          in: query
          type: string
        - name: event
          in: query
          type: string
        - name: start
          in: query
          type: string
        - name: end
          in: query
          type: string
        - name: page
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: includes
          in: query
          type: array
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: export-charts
      path: /export/charts
      operations:
      - name: get-export-charts
        method: GET
        description: Export aggregated chart/analytics data for a series of events over a time range.
        inputParameters:
        - name: breakdowns
          in: query
          type: array
          description: Array of dimensions to break down the data by
        - name: interval
          in: query
          type: string
          description: The time interval for data aggregation (e.g., day, week, month)
        - name: range
          in: query
          type: string
          description: The time range for which data should be displayed
        - name: previous
          in: query
          type: boolean
          description: Whether to show data from the previous period for comparison
        - name: startDate
          in: query
          type: string
          description: Custom start date for the data range (overrides range if provided)
        - name: endDate
          in: query
          type: string
          description: Custom end date for the data range (overrides range if provided)
        - name: project_id
          in: query
          type: string
        - name: projectId
          in: query
          type: string
        - name: series
          in: query
          type: array
        - name: events
          in: query
          type: array
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: import-events
      path: /import/events
      operations:
      - name: post-import-events
        method: POST
        description: Bulk import historical events.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-overview
      path: /insights/{projectId}/overview
      operations:
      - name: get-insights-projectid-overview
        method: GET
        description: Get an overview of key metrics for the project (sessions, pageviews, bounce rate, duration).
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: interval
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-active-users
      path: /insights/{projectId}/active_users
      operations:
      - name: get-insights-projectid-active-users
        method: GET
        description: Get rolling active user counts over the last N days.
        inputParameters:
        - name: days
          in: query
          type: integer
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-retention
      path: /insights/{projectId}/retention
      operations:
      - name: get-insights-projectid-retention
        method: GET
        description: Get weekly retention series data.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-retention-cohort
      path: /insights/{projectId}/retention/cohort
      operations:
      - name: get-insights-projectid-retention-cohort
        method: GET
        description: Get retention cohort data.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-pages-top
      path: /insights/{projectId}/pages/top
      operations:
      - name: get-insights-projectid-pages-top
        method: GET
        description: Get the top pages by pageviews for the given date range.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-pages-entry-exit
      path: /insights/{projectId}/pages/entry_exit
      operations:
      - name: get-insights-projectid-pages-entry-exit
        method: GET
        description: Get entry or exit pages ranked by session count.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: mode
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-pages-performance
      path: /insights/{projectId}/pages/performance
      operations:
      - name: get-insights-projectid-pages-performance
        method: GET
        description: Get page-level performance metrics (bounce rate, avg duration, sessions).
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: search
          in: query
          type: string
        - name: sortBy
          in: query
          type: string
        - name: sortOrder
          in: query
          type: string
        - name: limit
          in: query
          type: integer
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-metrics
      path: /insights/{projectId}/metrics
      operations:
      - name: get-insights-projectid-metrics
        method: GET
        description: Get aggregated website metrics including sessions, pageviews, and bounce rate.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: filters
          in: query
          type: array
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-live
      path: /insights/{projectId}/live
      operations:
      - name: get-insights-projectid-live
        method: GET
        description: Get the current number of live (active) visitors.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-pages
      path: /insights/{projectId}/pages
      operations:
      - name: get-insights-projectid-pages
        method: GET
        description: Get top pages with pageview counts for the selected date range.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-referrer
      path: /insights/{projectId}/referrer
      operations:
      - name: get-insights-projectid-referrer
        method: GET
        description: Get top values for the "referrer" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-referrer-name
      path: /insights/{projectId}/referrer_name
      operations:
      - name: get-insights-projectid-referrer-name
        method: GET
        description: Get top values for the "referrer_name" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-referrer-type
      path: /insights/{projectId}/referrer_type
      operations:
      - name: get-insights-projectid-referrer-type
        method: GET
        description: Get top values for the "referrer_type" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-utm-source
      path: /insights/{projectId}/utm_source
      operations:
      - name: get-insights-projectid-utm-source
        method: GET
        description: Get top values for the "utm_source" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-utm-medium
      path: /insights/{projectId}/utm_medium
      operations:
      - name: get-insights-projectid-utm-medium
        method: GET
        description: Get top values for the "utm_medium" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-utm-campaign
      path: /insights/{projectId}/utm_campaign
      operations:
      - name: get-insights-projectid-utm-campaign
        method: GET
        description: Get top values for the "utm_campaign" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-utm-term
      path: /insights/{projectId}/utm_term
      operations:
      - name: get-insights-projectid-utm-term
        method: GET
        description: Get top values for the "utm_term" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-utm-content
      path: /insights/{projectId}/utm_content
      operations:
      - name: get-insights-projectid-utm-content
        method: GET
        description: Get top values for the "utm_content" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-region
      path: /insights/{projectId}/region
      operations:
      - name: get-insights-projectid-region
        method: GET
        description: Get top values for the "region" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-country
      path: /insights/{projectId}/country
      operations:
      - name: get-insights-projectid-country
        method: GET
        description: Get top values for the "country" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-city
      path: /insights/{projectId}/city
      operations:
      - name: get-insights-projectid-city
        method: GET
        description: Get top values for the "city" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-device
      path: /insights/{projectId}/device
      operations:
      - name: get-insights-projectid-device
        method: GET
        description: Get top values for the "device" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-brand
      path: /insights/{projectId}/brand
      operations:
      - name: get-insights-projectid-brand
        method: GET
        description: Get top values for the "brand" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-model
      path: /insights/{projectId}/model
      operations:
      - name: get-insights-projectid-model
        method: GET
        description: Get top values for the "model" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-browser
      path: /insights/{projectId}/browser
      operations:
      - name: get-insights-projectid-browser
        method: GET
        description: Get top values for the "browser" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-browser-version
      path: /insights/{projectId}/browser_version
      operations:
      - name: get-insights-projectid-browser-version
        method: GET
        description: Get top values for the "browser_version" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-os
      path: /insights/{projectId}/os
      operations:
      - name: get-insights-projectid-os
        method: GET
        description: Get top values for the "os" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-os-version
      path: /insights/{projectId}/os_version
      operations:
      - name: get-insights-projectid-os-version
        method: GET
        description: Get top values for the "os_version" dimension.
        inputParameters:
        - name: filters
          in: query
          type: array
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: cursor
          in: query
          type: number
        - name: limit
          in: query
          type: number
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-funnel
      path: /insights/{projectId}/funnel
      operations:
      - name: get-insights-projectid-funnel
        method: GET
        description: Get funnel conversion rates for a sequence of events.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: steps
          in: query
          type: string
          required: true
        - name: windowHours
          in: query
          type: integer
        - name: groupBy
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-traffic-referrers
      path: /insights/{projectId}/traffic/referrers
      operations:
      - name: get-insights-projectid-traffic-referrers
        method: GET
        description: Get traffic breakdown by referrer source.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: breakdown
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-traffic-geo
      path: /insights/{projectId}/traffic/geo
      operations:
      - name: get-insights-projectid-traffic-geo
        method: GET
        description: Get traffic breakdown by geographic dimension (country, region, city).
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: breakdown
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-traffic-devices
      path: /insights/{projectId}/traffic/devices
      operations:
      - name: get-insights-projectid-traffic-devices
        method: GET
        description: Get traffic breakdown by device type, browser, or OS.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: breakdown
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-user-flow
      path: /insights/{projectId}/user_flow
      operations:
      - name: get-insights-projectid-user-flow
        method: GET
        description: Get user flow paths before, after, or between specified events.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: startEvent
          in: query
          type: string
          required: true
        - name: endEvent
          in: query
          type: string
        - name: mode
          in: query
          type: string
        - name: steps
          in: query
          type: integer
        - name: exclude
          in: query
          type: string
        - name: include
          in: query
          type: string
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-engagement
      path: /insights/{projectId}/engagement
      operations:
      - name: get-insights-projectid-engagement
        method: GET
        description: Get engagement metrics for the project.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: insights-projectid-events
      path: /insights/{projectId}/events
      operations:
      - name: get-insights-projectid-events
        method: GET
        description: Query events with optional filters for date range, profile, and properties.
        inputParameters:
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: range
          in: query
          type: string
        - name: eventNames
          in: query
          type: string
        - name: path
          in: query
          type: string
        - name: country
          in: query
          type: string
        - name: city
          in: query
          type: string
        - name: device
          in: query
          type: string
        - name: browser
          in: query
          type: string
        - name: os
          in: query
          type: string
        - name: referrer
 

# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpanel/refs/heads/main/capabilities/openpanel-capability.yaml