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 in: query type: string - name: referrerName in: query type: string - name: referrerType in: query type: string - name: profileId in: query type: string - name: properties in: query type: object - 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-events-names path: /insights/{projectId}/events/names operations: - name: get-insights-projectid-events-names method: GET description: List all distinct event names tracked in the project. inputParameters: - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-events-properties path: /insights/{projectId}/events/properties operations: - name: get-insights-projectid-events-properties method: GET description: List all property keys for a given event name. inputParameters: - name: eventName in: query type: string - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-events-property-values path: /insights/{projectId}/events/property_values operations: - name: get-insights-projectid-events-property-values method: GET description: Get the top values for a specific event property key. inputParameters: - name: eventName in: query type: string required: true - name: propertyKey in: query type: string required: true - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-profiles path: /insights/{projectId}/profiles operations: - name: get-insights-projectid-profiles method: GET description: Search and filter user profiles. inputParameters: - name: name in: query type: string - name: email 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: inactiveDays in: query type: integer - name: minSessions in: query type: integer - name: performedEvent 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-profiles-profileid path: /insights/{projectId}/profiles/{profileId} operations: - name: get-insights-projectid-profiles-profileid method: GET description: Get a single user profile with their recent events. inputParameters: - name: eventLimit in: query type: integer - name: projectId in: path type: string required: true - name: profileId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-profiles-profileid-sessions path: /insights/{projectId}/profiles/{profileId}/sessions operations: - name: get-insights-projectid-profiles-profileid-sessio method: GET description: Get sessions for a specific user profile. inputParameters: - name: limit in: query type: integer - name: projectId in: path type: string required: true - name: profileId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-profiles-profileid-metrics path: /insights/{projectId}/profiles/{profileId}/metrics operations: - name: get-insights-projectid-profiles-profileid-metric method: GET description: Get aggregated metrics for a specific user profile. inputParameters: - name: projectId in: path type: string required: true - name: profileId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-sessions path: /insights/{projectId}/sessions operations: - name: get-insights-projectid-sessions method: GET description: Query sessions with optional filters. inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range 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 in: query type: string - name: referrerName in: query type: string - name: referrerType in: query type: string - name: profileId 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-groups-types path: /insights/{projectId}/groups/types operations: - name: get-insights-projectid-groups-types method: GET description: List all group types defined in the project. inputParameters: - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-groups path: /insights/{projectId}/groups operations: - name: get-insights-projectid-groups method: GET description: Search and filter groups. inputParameters: - name: type in: query type: string - name: search 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-groups-groupid path: /insights/{projectId}/groups/{groupId} operations: - name: get-insights-projectid-groups-groupid method: GET description: Get a single group with its members. inputParameters: - name: memberLimit in: query type: integer - name: projectId in: path type: string required: true - name: groupId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-reports-reportid-data path: /insights/{projectId}/reports/{reportId}/data operations: - name: get-insights-projectid-reports-reportid-data method: GET description: Get the data for a saved report. inputParameters: - name: projectId in: path type: string required: true - name: reportId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-gsc-overview path: /insights/{projectId}/gsc/overview operations: - name: get-insights-projectid-gsc-overview method: GET description: Get a Google Search Console performance overview (clicks, impressions, CTR, position). 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-gsc-pages path: /insights/{projectId}/gsc/pages operations: - name: get-insights-projectid-gsc-pages method: GET description: Get top pages from Google Search Console. inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range 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-gsc-pages-details path: /insights/{projectId}/gsc/pages/details operations: - name: get-insights-projectid-gsc-pages-details method: GET description: Get detailed GSC metrics for a specific page URL. inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range in: query type: string - name: page in: query type: string required: true - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-gsc-queries path: /insights/{projectId}/gsc/queries operations: - name: get-insights-projectid-gsc-queries method: GET description: Get top search queries from Google Search Console. inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range 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-gsc-queries-details path: /insights/{projectId}/gsc/queries/details operations: - name: get-insights-projectid-gsc-queries-details method: GET description: Get detailed GSC metrics for a specific search query. inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range in: query type: string - name: query in: query type: string required: true - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: insights-projectid-gsc-queries-opportunities path: /insights/{projectId}/gsc/queries/opportunities operations: - name: get-insights-projectid-gsc-queries-opportunities method: GET description: Get GSC query opportunities (high impressions, low CTR). inputParameters: - name: startDate in: query type: string - name: endDate in: query type: string - name: range in: query type: string - name: minImpressions in: query type: integer - name: projectId in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: openpanel-rest description: REST adapter for OpenPanel API. resources: - path: /event/ name: post-event operations: - method: POST name: post-event description: Deprecated direct event ingestion endpoint. Use /track instead. call: openpanel.post-event outputParameters: - type: object mapping: $. - path: /profile/ name: post-profile operations: - method: POST name: post-profile description: Identify or update a user profile. call: openpanel.post-profile outputParameters: - type: object mapping: $. - path: /profile/increment name: post-profile-increment operations: - method: POST name: post-profile-increment description: Increment a numeric property on a user profile. call: openpanel.post-profile-increment outputParameters: - type: object mapping: $. - path: /profile/decrement name: post-profile-decrement operations: - method: POST name: post-profile-decrement description: Decrement a numeric property on a user profile. call: openpanel.post-profile-decrement outputParameters: - type: object mapping: $. - path: /export/events name: get-export-events operations: - method: GET name: get-export-events description: Export a paginated list of raw events with optional filtering by date, profile, and event type. call: openpanel.get-export-events outputParameters: - type: object mapping: $. - path: /export/charts name: get-export-charts operations: - method: GET name: get-export-charts description: Export aggregated chart/analytics data for a series of events over a time range. call: openpanel.get-export-charts outputParameters: - type: object mapping: $. - path: /import/events name: post-import-events operations: - method: POST name: post-import-events description: Bulk import historical events. call: openpanel.post-import-events outputParameters: - type: object mapping: $. - path: /insights/{projectId}/overview name: get-insights-projectid-overview operations: - method: GET name: get-insights-projectid-overview description: Get an overview of key metrics for the project (sessions, pageviews, bounce rate, duration). call: openpanel.get-insights-projectid-overview with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/active_users name: get-insights-projectid-active-users operations: - method: GET name: get-insights-projectid-active-users description: Get rolling active user counts over the last N days. call: openpanel.get-insights-projectid-active-users with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/retention name: get-insights-projectid-retention operations: - method: GET name: get-insights-projectid-retention description: Get weekly retention series data. call: openpanel.get-insights-projectid-retention with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/retention/cohort name: get-insights-projectid-retention-cohort operations: - method: GET name: get-insights-projectid-retention-cohort description: Get retention cohort data. call: openpanel.get-insights-projectid-retention-cohort with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/pages/top name: get-insights-projectid-pages-top operations: - method: GET name: get-insights-projectid-pages-top description: Get the top pages by pageviews for the given date range. call: openpanel.get-insights-projectid-pages-top with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/pages/entry_exit name: get-insights-projectid-pages-entry-exit operations: - method: GET name: get-insights-projectid-pages-entry-exit description: Get entry or exit pages ranked by session count. call: openpanel.get-insights-projectid-pages-entry-exit with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/pages/performance name: get-insights-projectid-pages-performance operations: - method: GET name: get-insights-projectid-pages-performance description: Get page-level performance metrics (bounce rate, avg duration, sessions). call: openpanel.get-insights-projectid-pages-performance with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/metrics name: get-insights-projectid-metrics operations: - method: GET name: get-insights-projectid-metrics description: Get aggregated website metrics including sessions, pageviews, and bounce rate. call: openpanel.get-insights-projectid-metrics with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/live name: get-insights-projectid-live operations: - method: GET name: get-insights-projectid-live description: Get the current number of live (active) visitors. call: openpanel.get-insights-projectid-live with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/pages name: get-insights-projectid-pages operations: - method: GET name: get-insights-projectid-pages description: Get top pages with pageview counts for the selected date range. call: openpanel.get-insights-projectid-pages with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/referrer name: get-insights-projectid-referrer operations: - method: GET name: get-insights-projectid-referrer description: Get top values for the "referrer" dimension. call: openpanel.get-insights-projectid-referrer with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/referrer_name name: get-insights-projectid-referrer-name operations: - method: GET name: get-insights-projectid-referrer-name description: Get top values for the "referrer_name" dimension. call: openpanel.get-insights-projectid-referrer-name with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/referrer_type name: get-insights-projectid-referrer-type operations: - method: GET name: get-insights-projectid-referrer-type description: Get top values for the "referrer_type" dimension. call: openpanel.get-insights-projectid-referrer-type with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/utm_source name: get-insights-projectid-utm-source operations: - method: GET name: get-insights-projectid-utm-source description: Get top values for the "utm_source" dimension. call: openpanel.get-insights-projectid-utm-source with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/utm_medium name: get-insights-projectid-utm-medium operations: - method: GET name: get-insights-projectid-utm-medium description: Get top values for the "utm_medium" dimension. call: openpanel.get-insights-projectid-utm-medium with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/utm_campaign name: get-insights-projectid-utm-campaign operations: - method: GET name: get-insights-projectid-utm-campaign description: Get top values for the "utm_campaign" dimension. call: openpanel.get-insights-projectid-utm-campaign with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/utm_term name: get-insights-projectid-utm-term operations: - method: GET name: get-insights-projectid-utm-term description: Get top values for the "utm_term" dimension. call: openpanel.get-insights-projectid-utm-term with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/utm_content name: get-insights-projectid-utm-content operations: - method: GET name: get-insights-projectid-utm-content description: Get top values for the "utm_content" dimension. call: openpanel.get-insights-projectid-utm-content with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/region name: get-insights-projectid-region operations: - method: GET name: get-insights-projectid-region description: Get top values for the "region" dimension. call: openpanel.get-insights-projectid-region with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/country name: get-insights-projectid-country operations: - method: GET name: get-insights-projectid-country description: Get top values for the "country" dimension. call: openpanel.get-insights-projectid-country with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/city name: get-insights-projectid-city operations: - method: GET name: get-insights-projectid-city description: Get top values for the "city" dimension. call: openpanel.get-insights-projectid-city with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/device name: get-insights-projectid-device operations: - method: GET name: get-insights-projectid-device description: Get top values for the "device" dimension. call: openpanel.get-insights-projectid-device with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/brand name: get-insights-projectid-brand operations: - method: GET name: get-insights-projectid-brand description: Get top values for the "brand" dimension. call: openpanel.get-insights-projectid-brand with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/model name: get-insights-projectid-model operations: - method: GET name: get-insights-projectid-model description: Get top values for the "model" dimension. call: openpanel.get-insights-projectid-model with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/browser name: get-insights-projectid-browser operations: - method: GET name: get-insights-projectid-browser description: Get top values for the "browser" dimension. call: openpanel.get-insights-projectid-browser with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/browser_version name: get-insights-projectid-browser-version operations: - method: GET name: get-insights-projectid-browser-version description: Get top values for the "browser_version" dimension. call: openpanel.get-insights-projectid-browser-version with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/os name: get-insights-projectid-os operations: - method: GET name: get-insights-projectid-os description: Get top values for the "os" dimension. call: openpanel.get-insights-projectid-os with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/os_version name: get-insights-projectid-os-version operations: - method: GET name: get-insights-projectid-os-version description: Get top values for the "os_version" dimension. call: openpanel.get-insights-projectid-os-version with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/funnel name: get-insights-projectid-funnel operations: - method: GET name: get-insights-projectid-funnel description: Get funnel conversion rates for a sequence of events. call: openpanel.get-insights-projectid-funnel with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/traffic/referrers name: get-insights-projectid-traffic-referrers operations: - method: GET name: get-insights-projectid-traffic-referrers description: Get traffic breakdown by referrer source. call: openpanel.get-insights-projectid-traffic-referrers with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/traffic/geo name: get-insights-projectid-traffic-geo operations: - method: GET name: get-insights-projectid-traffic-geo description: Get traffic breakdown by geographic dimension (country, region, city). call: openpanel.get-insights-projectid-traffic-geo with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/traffic/devices name: get-insights-projectid-traffic-devices operations: - method: GET name: get-insights-projectid-traffic-devices description: Get traffic breakdown by device type, browser, or OS. call: openpanel.get-insights-projectid-traffic-devices with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/user_flow name: get-insights-projectid-user-flow operations: - method: GET name: get-insights-projectid-user-flow description: Get user flow paths before, after, or between specified events. call: openpanel.get-insights-projectid-user-flow with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/engagement name: get-insights-projectid-engagement operations: - method: GET name: get-insights-projectid-engagement description: Get engagement metrics for the project. call: openpanel.get-insights-projectid-engagement with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/events name: get-insights-projectid-events operations: - method: GET name: get-insights-projectid-events description: Query events with optional filters for date range, profile, and properties. call: openpanel.get-insights-projectid-events with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/events/names name: get-insights-projectid-events-names operations: - method: GET name: get-insights-projectid-events-names description: List all distinct event names tracked in the project. call: openpanel.get-insights-projectid-events-names with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/events/properties name: get-insights-projectid-events-properties operations: - method: GET name: get-insights-projectid-events-properties description: List all property keys for a given event name. call: openpanel.get-insights-projectid-events-properties with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/events/property_values name: get-insights-projectid-events-property-values operations: - method: GET name: get-insights-projectid-events-property-values description: Get the top values for a specific event property key. call: openpanel.get-insights-projectid-events-property-values with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/profiles name: get-insights-projectid-profiles operations: - method: GET name: get-insights-projectid-profiles description: Search and filter user profiles. call: openpanel.get-insights-projectid-profiles with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/profiles/{profileId} name: get-insights-projectid-profiles-profileid operations: - method: GET name: get-insights-projectid-profiles-profileid description: Get a single user profile with their recent events. call: openpanel.get-insights-projectid-profiles-profileid with: projectId: rest.projectId profileId: rest.profileId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/profiles/{profileId}/sessions name: get-insights-projectid-profiles-profileid-sessio operations: - method: GET name: get-insights-projectid-profiles-profileid-sessio description: Get sessions for a specific user profile. call: openpanel.get-insights-projectid-profiles-profileid-sessio with: projectId: rest.projectId profileId: rest.profileId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/profiles/{profileId}/metrics name: get-insights-projectid-profiles-profileid-metric operations: - method: GET name: get-insights-projectid-profiles-profileid-metric description: Get aggregated metrics for a specific user profile. call: openpanel.get-insights-projectid-profiles-profileid-metric with: projectId: rest.projectId profileId: rest.profileId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/sessions name: get-insights-projectid-sessions operations: - method: GET name: get-insights-projectid-sessions description: Query sessions with optional filters. call: openpanel.get-insights-projectid-sessions with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/groups/types name: get-insights-projectid-groups-types operations: - method: GET name: get-insights-projectid-groups-types description: List all group types defined in the project. call: openpanel.get-insights-projectid-groups-types with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/groups name: get-insights-projectid-groups operations: - method: GET name: get-insights-projectid-groups description: Search and filter groups. call: openpanel.get-insights-projectid-groups with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/groups/{groupId} name: get-insights-projectid-groups-groupid operations: - method: GET name: get-insights-projectid-groups-groupid description: Get a single group with its members. call: openpanel.get-insights-projectid-groups-groupid with: projectId: rest.projectId groupId: rest.groupId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/reports/{reportId}/data name: get-insights-projectid-reports-reportid-data operations: - method: GET name: get-insights-projectid-reports-reportid-data description: Get the data for a saved report. call: openpanel.get-insights-projectid-reports-reportid-data with: projectId: rest.projectId reportId: rest.reportId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/overview name: get-insights-projectid-gsc-overview operations: - method: GET name: get-insights-projectid-gsc-overview description: Get a Google Search Console performance overview (clicks, impressions, CTR, position). call: openpanel.get-insights-projectid-gsc-overview with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/pages name: get-insights-projectid-gsc-pages operations: - method: GET name: get-insights-projectid-gsc-pages description: Get top pages from Google Search Console. call: openpanel.get-insights-projectid-gsc-pages with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/pages/details name: get-insights-projectid-gsc-pages-details operations: - method: GET name: get-insights-projectid-gsc-pages-details description: Get detailed GSC metrics for a specific page URL. call: openpanel.get-insights-projectid-gsc-pages-details with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/queries name: get-insights-projectid-gsc-queries operations: - method: GET name: get-insights-projectid-gsc-queries description: Get top search queries from Google Search Console. call: openpanel.get-insights-projectid-gsc-queries with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/queries/details name: get-insights-projectid-gsc-queries-details operations: - method: GET name: get-insights-projectid-gsc-queries-details description: Get detailed GSC metrics for a specific search query. call: openpanel.get-insights-projectid-gsc-queries-details with: projectId: rest.projectId outputParameters: - type: object mapping: $. - path: /insights/{projectId}/gsc/queries/opportunities name: get-insights-projectid-gsc-queries-opportunities operations: - method: GET name: get-insights-projectid-gsc-queries-opportunities description: Get GSC query opportunities (high impressions, low CTR). call: openpanel.get-insights-projectid-gsc-queries-opportunities with: projectId: rest.projectId outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: openpanel-mcp transport: http description: MCP adapter for OpenPanel API for AI agent use. tools: - name: post-event description: Deprecated direct event ingestion endpoint. Use /track instead. hints: readOnly: false destructive: false idempotent: false call: openpanel.post-event outputParameters: - type: object mapping: $. - name: post-profile description: Identify or update a user profile. hints: readOnly: false destructive: false idempotent: false call: openpanel.post-profile outputParameters: - type: object mapping: $. - name: post-profile-increment description: Increment a numeric property on a user profile. hints: readOnly: false destructive: false idempotent: false call: openpanel.post-profile-increment outputParameters: - type: object mapping: $. - name: post-profile-decrement description: Decrement a numeric property on a user profile. hints: readOnly: false destructive: false idempotent: false call: openpanel.post-profile-decrement outputParameters: - type: object mapping: $. - name: get-export-events description: Export a paginated list of raw events with optional filtering by date, profile, and event type. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-export-events with: project_id: tools.project_id projectId: tools.projectId profileId: tools.profileId event: tools.event start: tools.start end: tools.end page: tools.page limit: tools.limit includes: tools.includes inputParameters: - name: project_id type: string description: project_id - name: projectId type: string description: projectId - name: profileId type: string description: profileId - name: event type: string description: event - name: start type: string description: start - name: end type: string description: end - name: page type: number description: page - name: limit type: number description: limit - name: includes type: array description: includes outputParameters: - type: object mapping: $. - name: get-export-charts description: Export aggregated chart/analytics data for a series of events over a time range. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-export-charts with: breakdowns: tools.breakdowns interval: tools.interval range: tools.range previous: tools.previous startDate: tools.startDate endDate: tools.endDate project_id: tools.project_id projectId: tools.projectId series: tools.series events: tools.events inputParameters: - name: breakdowns type: array description: Array of dimensions to break down the data by - name: interval type: string description: The time interval for data aggregation (e.g., day, week, month) - name: range type: string description: The time range for which data should be displayed - name: previous type: boolean description: Whether to show data from the previous period for comparison - name: startDate type: string description: Custom start date for the data range (overrides range if provided) - name: endDate type: string description: Custom end date for the data range (overrides range if provided) - name: project_id type: string description: project_id - name: projectId type: string description: projectId - name: series type: array description: series - name: events type: array description: events outputParameters: - type: object mapping: $. - name: post-import-events description: Bulk import historical events. hints: readOnly: false destructive: false idempotent: false call: openpanel.post-import-events outputParameters: - type: object mapping: $. - name: get-insights-projectid-overview description: Get an overview of key metrics for the project (sessions, pageviews, bounce rate, duration). hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-overview with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range interval: tools.interval inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: interval type: string description: interval outputParameters: - type: object mapping: $. - name: get-insights-projectid-active-users description: Get rolling active user counts over the last N days. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-active-users with: projectId: tools.projectId days: tools.days inputParameters: - name: projectId type: string description: projectId required: true - name: days type: integer description: days outputParameters: - type: object mapping: $. - name: get-insights-projectid-retention description: Get weekly retention series data. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-retention with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-retention-cohort description: Get retention cohort data. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-retention-cohort with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-pages-top description: Get the top pages by pageviews for the given date range. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-pages-top with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range outputParameters: - type: object mapping: $. - name: get-insights-projectid-pages-entry-exit description: Get entry or exit pages ranked by session count. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-pages-entry-exit with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range mode: tools.mode inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: mode type: string description: mode outputParameters: - type: object mapping: $. - name: get-insights-projectid-pages-performance description: Get page-level performance metrics (bounce rate, avg duration, sessions). hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-pages-performance with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range search: tools.search sortBy: tools.sortBy sortOrder: tools.sortOrder limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: search type: string description: search - name: sortBy type: string description: sortBy - name: sortOrder type: string description: sortOrder - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-metrics description: Get aggregated website metrics including sessions, pageviews, and bounce rate. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-metrics with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range filters: tools.filters inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: filters type: array description: filters outputParameters: - type: object mapping: $. - name: get-insights-projectid-live description: Get the current number of live (active) visitors. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-live with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-pages description: Get top pages with pageview counts for the selected date range. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-pages with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-referrer description: Get top values for the "referrer" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-referrer with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-referrer-name description: Get top values for the "referrer_name" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-referrer-name with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-referrer-type description: Get top values for the "referrer_type" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-referrer-type with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-utm-source description: Get top values for the "utm_source" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-utm-source with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-utm-medium description: Get top values for the "utm_medium" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-utm-medium with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-utm-campaign description: Get top values for the "utm_campaign" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-utm-campaign with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-utm-term description: Get top values for the "utm_term" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-utm-term with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-utm-content description: Get top values for the "utm_content" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-utm-content with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-region description: Get top values for the "region" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-region with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-country description: Get top values for the "country" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-country with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-city description: Get top values for the "city" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-city with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-device description: Get top values for the "device" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-device with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-brand description: Get top values for the "brand" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-brand with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-model description: Get top values for the "model" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-model with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-browser description: Get top values for the "browser" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-browser with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-browser-version description: Get top values for the "browser_version" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-browser-version with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-os description: Get top values for the "os" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-os with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-os-version description: Get top values for the "os_version" dimension. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-os-version with: projectId: tools.projectId filters: tools.filters startDate: tools.startDate endDate: tools.endDate range: tools.range cursor: tools.cursor limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: filters type: array description: filters - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: cursor type: number description: cursor - name: limit type: number description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-funnel description: Get funnel conversion rates for a sequence of events. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-funnel with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range steps: tools.steps windowHours: tools.windowHours groupBy: tools.groupBy inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: steps type: string description: steps required: true - name: windowHours type: integer description: windowHours - name: groupBy type: string description: groupBy outputParameters: - type: object mapping: $. - name: get-insights-projectid-traffic-referrers description: Get traffic breakdown by referrer source. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-traffic-referrers with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range breakdown: tools.breakdown inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: breakdown type: string description: breakdown outputParameters: - type: object mapping: $. - name: get-insights-projectid-traffic-geo description: Get traffic breakdown by geographic dimension (country, region, city). hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-traffic-geo with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range breakdown: tools.breakdown inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: breakdown type: string description: breakdown outputParameters: - type: object mapping: $. - name: get-insights-projectid-traffic-devices description: Get traffic breakdown by device type, browser, or OS. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-traffic-devices with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range breakdown: tools.breakdown inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: breakdown type: string description: breakdown outputParameters: - type: object mapping: $. - name: get-insights-projectid-user-flow description: Get user flow paths before, after, or between specified events. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-user-flow with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range startEvent: tools.startEvent endEvent: tools.endEvent mode: tools.mode steps: tools.steps exclude: tools.exclude include: tools.include inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: startEvent type: string description: startEvent required: true - name: endEvent type: string description: endEvent - name: mode type: string description: mode - name: steps type: integer description: steps - name: exclude type: string description: exclude - name: include type: string description: include outputParameters: - type: object mapping: $. - name: get-insights-projectid-engagement description: Get engagement metrics for the project. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-engagement with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-events description: Query events with optional filters for date range, profile, and properties. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-events with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range eventNames: tools.eventNames path: tools.path country: tools.country city: tools.city device: tools.device browser: tools.browser os: tools.os referrer: tools.referrer referrerName: tools.referrerName referrerType: tools.referrerType profileId: tools.profileId properties: tools.properties limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: eventNames type: string description: eventNames - name: path type: string description: path - name: country type: string description: country - name: city type: string description: city - name: device type: string description: device - name: browser type: string description: browser - name: os type: string description: os - name: referrer type: string description: referrer - name: referrerName type: string description: referrerName - name: referrerType type: string description: referrerType - name: profileId type: string description: profileId - name: properties type: object description: properties - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-events-names description: List all distinct event names tracked in the project. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-events-names with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-events-properties description: List all property keys for a given event name. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-events-properties with: projectId: tools.projectId eventName: tools.eventName inputParameters: - name: projectId type: string description: projectId required: true - name: eventName type: string description: eventName outputParameters: - type: object mapping: $. - name: get-insights-projectid-events-property-values description: Get the top values for a specific event property key. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-events-property-values with: projectId: tools.projectId eventName: tools.eventName propertyKey: tools.propertyKey inputParameters: - name: projectId type: string description: projectId required: true - name: eventName type: string description: eventName required: true - name: propertyKey type: string description: propertyKey required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-profiles description: Search and filter user profiles. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-profiles with: projectId: tools.projectId name: tools.name email: tools.email country: tools.country city: tools.city device: tools.device browser: tools.browser inactiveDays: tools.inactiveDays minSessions: tools.minSessions performedEvent: tools.performedEvent sortOrder: tools.sortOrder limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: name type: string description: name - name: email type: string description: email - name: country type: string description: country - name: city type: string description: city - name: device type: string description: device - name: browser type: string description: browser - name: inactiveDays type: integer description: inactiveDays - name: minSessions type: integer description: minSessions - name: performedEvent type: string description: performedEvent - name: sortOrder type: string description: sortOrder - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-profiles-profileid description: Get a single user profile with their recent events. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-profiles-profileid with: projectId: tools.projectId profileId: tools.profileId eventLimit: tools.eventLimit inputParameters: - name: projectId type: string description: projectId required: true - name: profileId type: string description: profileId required: true - name: eventLimit type: integer description: eventLimit outputParameters: - type: object mapping: $. - name: get-insights-projectid-profiles-profileid-sessio description: Get sessions for a specific user profile. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-profiles-profileid-sessio with: projectId: tools.projectId profileId: tools.profileId limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: profileId type: string description: profileId required: true - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-profiles-profileid-metric description: Get aggregated metrics for a specific user profile. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-profiles-profileid-metric with: projectId: tools.projectId profileId: tools.profileId inputParameters: - name: projectId type: string description: projectId required: true - name: profileId type: string description: profileId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-sessions description: Query sessions with optional filters. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-sessions with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range country: tools.country city: tools.city device: tools.device browser: tools.browser os: tools.os referrer: tools.referrer referrerName: tools.referrerName referrerType: tools.referrerType profileId: tools.profileId limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: country type: string description: country - name: city type: string description: city - name: device type: string description: device - name: browser type: string description: browser - name: os type: string description: os - name: referrer type: string description: referrer - name: referrerName type: string description: referrerName - name: referrerType type: string description: referrerType - name: profileId type: string description: profileId - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-groups-types description: List all group types defined in the project. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-groups-types with: projectId: tools.projectId inputParameters: - name: projectId type: string description: projectId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-groups description: Search and filter groups. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-groups with: projectId: tools.projectId type: tools.type search: tools.search limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: type type: string description: type - name: search type: string description: search - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-groups-groupid description: Get a single group with its members. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-groups-groupid with: projectId: tools.projectId groupId: tools.groupId memberLimit: tools.memberLimit inputParameters: - name: projectId type: string description: projectId required: true - name: groupId type: string description: groupId required: true - name: memberLimit type: integer description: memberLimit outputParameters: - type: object mapping: $. - name: get-insights-projectid-reports-reportid-data description: Get the data for a saved report. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-reports-reportid-data with: projectId: tools.projectId reportId: tools.reportId inputParameters: - name: projectId type: string description: projectId required: true - name: reportId type: string description: reportId required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-overview description: Get a Google Search Console performance overview (clicks, impressions, CTR, position). hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-overview with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range interval: tools.interval inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: interval type: string description: interval outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-pages description: Get top pages from Google Search Console. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-pages with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-pages-details description: Get detailed GSC metrics for a specific page URL. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-pages-details with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range page: tools.page inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: page type: string description: page required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-queries description: Get top search queries from Google Search Console. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-queries with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range limit: tools.limit inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: limit type: integer description: limit outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-queries-details description: Get detailed GSC metrics for a specific search query. hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-queries-details with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range query: tools.query inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: query type: string description: query required: true outputParameters: - type: object mapping: $. - name: get-insights-projectid-gsc-queries-opportunities description: Get GSC query opportunities (high impressions, low CTR). hints: readOnly: true destructive: false idempotent: true call: openpanel.get-insights-projectid-gsc-queries-opportunities with: projectId: tools.projectId startDate: tools.startDate endDate: tools.endDate range: tools.range minImpressions: tools.minImpressions inputParameters: - name: projectId type: string description: projectId required: true - name: startDate type: string description: startDate - name: endDate type: string description: endDate - name: range type: string description: range - name: minImpressions type: integer description: minImpressions outputParameters: - type: object mapping: $.