Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

kapa.ai Analytics API

Activity, coverage gaps, and top questions.

kapa.ai Analytics API is one of 6 APIs that kapa.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.kapa.ai.

7 operations 7 paths 1 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.kapa.ai/query/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

kapa.ai Analytics API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — kapa.ai project API key, created in the API Keys tab of the platform.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Analytics 7

Activity, coverage gaps, and top questions.

GET
/query/v1/projects/{project_id}/activity
Activity data
getActivity 1 param → 200401
GET
/query/v1/projects/{project_id}/question-answers
List question answers
listQuestionAnswers 3 params → 200401
GET
/query/v1/projects/{project_id}/end-users
List end users
listEndUsers 1 param → 200401
GET
/query/v1/projects/{project_id}/coverage-gaps/periods
List coverage gaps periods
listCoverageGapsPeriods 1 param → 200401
GET
/query/v1/coverage-gaps/periods/{period_id}
Retrieve coverage gaps period
getCoverageGapsPeriod 1 param → 200401
GET
/query/v1/projects/{project_id}/top-questions/periods
List top questions periods
listTopQuestionsPeriods 1 param → 200401
GET
/query/v1/top-questions/periods/{period_id}
Retrieve top questions period
getTopQuestionsPeriod 1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kapa-ai-analytics-api-openapi.yml Raw ↑

Other APIs kapa.ai publishes across the network.

kapa.ai Chat API
kapa.ai Feedback API
kapa.ai Projects API
kapa.ai Retrieval API
kapa.ai Threads API