inkeep-analytics-typescript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage inkeep-analytics-typescript API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Inkeep Analytics API: The Inkeep Analytics API provides endpoints for managing conversations, feedback, events, and queries. For details on authentication, see authentication documentation

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @inkeep/inkeep-analytics
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM

pnpm add @inkeep/inkeep-analytics
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun

bun add @inkeep/inkeep-analytics
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn

yarn add @inkeep/inkeep-analytics zod
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "InkeepAnalytics": {
      "command": "npx",
      "args": [
        "-y", "--package", "@inkeep/inkeep-analytics",
        "--",
        "mcp", "start",
        "--api-integration-key", "..."
      ]
    }
  }
}

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "InkeepAnalytics": {
      "command": "npx",
      "args": [
        "-y", "--package", "@inkeep/inkeep-analytics",
        "--",
        "mcp", "start",
        "--api-integration-key", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @inkeep/inkeep-analytics -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics({
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  const result = await inkeepAnalytics.topSearchQueries({});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`apiIntegrationKey`	http	HTTP Bearer	`INKEEPANALYTICS_API_INTEGRATION_KEY`

To authenticate with the API the apiIntegrationKey parameter must be set when initializing the SDK client instance. For example:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics({
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  const result = await inkeepAnalytics.topSearchQueries({});

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics();

async function run() {
  const result = await inkeepAnalytics.conversations.log({}, {
    type: "support_copilot",
    messages: [
      {
        role: "<value>",
        userProperties: {
          identificationType: "COOKIED",
        },
      },
    ],
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

conversation

getConversationByExternalId - Get Conversation by External ID

conversations

log - Log Conversation
list - Get All Conversations
get - Get Conversation
delete - Delete Conversation

events

log - Log Event

feedback

submit - Submit Feedback
list - Get All Feedback
getFeedbackById - Get Feedback by ID

InkeepAnalytics SDK

topSearchQueries - Top Search Queries
weeklySearchUsers - Weekly Search Users

query

conversations - Query Conversations
queryEvents - Query Events
queryFeedback - Query Feedback
querySemanticThreads - Query Semantic Threads
exportSemanticThreadsQueryResults - Export Semantic Threads Query Results
queryPropertyKeys - Query Property Keys
queryPropertyValues - Query Property Values

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

conversationGetConversationByExternalId - Get Conversation by External ID
conversationsDelete - Delete Conversation
conversationsGet - Get Conversation
conversationsList - Get All Conversations
conversationsLog - Log Conversation
eventsLog - Log Event
feedbackGetFeedbackById - Get Feedback by ID
feedbackList - Get All Feedback
feedbackSubmit - Submit Feedback
queryConversations - Query Conversations
queryExportSemanticThreadsQueryResults - Export Semantic Threads Query Results
queryQueryEvents - Query Events
queryQueryFeedback - Query Feedback
queryQueryPropertyKeys - Query Property Keys
queryQueryPropertyValues - Query Property Values
queryQuerySemanticThreads - Query Semantic Threads
topSearchQueries - Top Search Queries
weeklySearchUsers - Weekly Search Users

React hooks with TanStack Query

React hooks built on TanStack Query are included in this SDK. These hooks and the utility functions provided alongside them can be used to build rich applications that pull data from the API using one of the most popular asynchronous state management library.

To learn about this feature and how to get started, check REACT_QUERY.md.

Warning

This feature is currently in preview and is subject to breaking changes within the current major version of the SDK as we gather user feedback on it.

Available React hooks

useConversationGetConversationByExternalId - Get Conversation by External ID
useConversationsDeleteMutation - Delete Conversation
useConversationsGet - Get Conversation
useConversationsList - Get All Conversations
useConversationsLogMutation - Log Conversation
useEventsLogMutation - Log Event
useFeedbackGetFeedbackById - Get Feedback by ID
useFeedbackList - Get All Feedback
useFeedbackSubmitMutation - Submit Feedback
useQueryConversationsMutation - Query Conversations
useQueryExportSemanticThreadsQueryResultsMutation - Export Semantic Threads Query Results
useQueryQueryEventsMutation - Query Events
useQueryQueryFeedbackMutation - Query Feedback
useQueryQueryPropertyKeysMutation - Query Property Keys
useQueryQueryPropertyValuesMutation - Query Property Values
useQueryQuerySemanticThreadsMutation - Query Semantic Threads
useTopSearchQueries - Top Search Queries
useWeeklySearchUsers - Weekly Search Users

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics({
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  const result = await inkeepAnalytics.topSearchQueries({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  const result = await inkeepAnalytics.topSearchQueries({});

  console.log(result);
}

run();

Error Handling

This table shows properties which are common on error classes. For full details see error classes.

Property	Type	Description
`error.name`	`string`	Error class name eg `APIError`
`error.message`	`string`	Error message
`error.statusCode`	`number`	HTTP status code eg `404`
`error.contentType`	`string`	HTTP content type eg `application/json`
`error.body`	`string`	HTTP body. Can be empty string if no body is returned.
`error.rawResponse`	`Response`	Raw HTTP response. Access to headers and more.
`error.data$`		Optional. Some errors may contain structured data. See Error Classes.

Example

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";
import * as errors from "@inkeep/inkeep-analytics/models/errors";

const inkeepAnalytics = new InkeepAnalytics({
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  try {
    const result = await inkeepAnalytics.topSearchQueries({});

    console.log(result);
  } catch (error) {
    // Depending on the method different errors may be thrown
    if (error instanceof errors.BadRequest) {
      console.log(error.message);
      console.log(error.data$.title); // string
      console.log(error.data$.status); // number
      console.log(error.data$.detail); // string
      console.log(error.data$.instance); // string
      console.log(error.data$.requestId); // string
    }

    // Fallback error class, if no other more specific error class is matched
    if (error instanceof errors.APIError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.rawResponse.headers);
    }
  }
}

run();

Error Classes

BadRequest: Bad Request. Status code 400.
Unauthorized: Unauthorized. Status code 401.
Forbidden: Forbidden. Status code 403.
UnprocessableEntity: Unprocessable Entity. Status code 422.
InternalServerError: Internal Server Error. Status code 500.
APIError: The fallback error class, if no other more specific error class is matched.
SDKValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.
Network errors:
- ConnectionError: HTTP client was unable to make a request to a server.
- RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
- RequestAbortedError: HTTP request was aborted by the client.
- InvalidRequestError: Any input used to create a request is invalid.
- UnexpectedClientError: Unrecognised or unexpected error.
Less common errors, applicable to a subset of methods:
- NotFound: Not Found. Status code 404. Applicable to 6 of 18 methods.*

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const inkeepAnalytics = new InkeepAnalytics({
  serverURL: "https://api.analytics.inkeep.com",
  apiIntegrationKey: process.env["INKEEPANALYTICS_API_INTEGRATION_KEY"] ?? "",
});

async function run() {
  const result = await inkeepAnalytics.topSearchQueries({});

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";
import { HTTPClient } from "@inkeep/inkeep-analytics/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new InkeepAnalytics({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { InkeepAnalytics } from "@inkeep/inkeep-analytics";

const sdk = new InkeepAnalytics({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable INKEEPANALYTICS_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 45 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
REACT_QUERY.md		REACT_QUERY.md
README.md		README.md
RELEASES.md		RELEASES.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

inkeep/inkeep-analytics-typescript

Folders and files

Latest commit

History

Repository files navigation

inkeep-analytics-typescript

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Model Context Protocol (MCP) Server

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Available Resources and Operations

Standalone functions

React hooks with TanStack Query

Retries

Error Handling

Example

Error Classes

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Uh oh!

Stars

Watchers

Forks

Uh oh!

Uh oh!

Languages