Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/inkeep/inkeep-analytics-typescript


https://github.com/inkeep/inkeep-analytics-typescript

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README 

          
# 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](https://app.speakeasy.com/org/inkeep/inkeep). 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](/analytics-api/authentication)



## Table of Contents



* [inkeep-analytics-typescript](#inkeep-analytics-typescript)

  * [SDK Installation](#sdk-installation)

  * [Requirements](#requirements)

  * [SDK Example Usage](#sdk-example-usage)

  * [Authentication](#authentication)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Standalone functions](#standalone-functions)

  * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)

  * [Retries](#retries)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

  * [Custom HTTP Client](#custom-http-client)

  * [Debugging](#debugging)

* [Development](#development)

  * [Maturity](#maturity)

  * [Contributions](#contributions)



## SDK Installation



The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.



### NPM



```bash

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



```bash

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



```bash

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



```bash

yarn add @inkeep/inkeep-analytics

# Install optional peer dependencies if you plan to use React hooks

yarn add @tanstack/react-query react react-dom

```



> [!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:



```json

{

  "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:



```json

{

  "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:



```bash

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}"`.



```json

{

  "mcpServers": {

    "Todos": {

      "command": "./DOWNLOAD/PATH/mcp-server",

      "args": [

        "start"

      ]

    }

  }

}

```



For a full list of server arguments, run:



```sh

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

```



## Requirements



For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).



## SDK Example Usage



### Example



```typescript

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:

```typescript

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:

```typescript

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



const inkeepAnalytics = new InkeepAnalytics();



async function run() {

  const result = await inkeepAnalytics.conversations.log({}, {

    type: "support_copilot",

    messages: [

      {

        role: "",

        userProperties: {

          identificationType: "COOKIED",

        },

      },

    ],

  });



  console.log(result);

}



run();



```



## Available Resources and Operations



Available methods



### [InkeepAnalytics SDK](docs/sdks/inkeepanalytics/README.md)



* [topSearchQueries](docs/sdks/inkeepanalytics/README.md#topsearchqueries) - Top Search Queries

* [weeklySearchUsers](docs/sdks/inkeepanalytics/README.md#weeklysearchusers) - Weekly Search Users



### [Conversation](docs/sdks/conversation/README.md)



* [getConversationByExternalId](docs/sdks/conversation/README.md#getconversationbyexternalid) - Get Conversation by External ID



### [Conversations](docs/sdks/conversations/README.md)



* [log](docs/sdks/conversations/README.md#log) - Log Conversation

* [list](docs/sdks/conversations/README.md#list) - Get All Conversations

* [get](docs/sdks/conversations/README.md#get) - Get Conversation

* [delete](docs/sdks/conversations/README.md#delete) - Delete Conversation



### [Events](docs/sdks/events/README.md)



* [log](docs/sdks/events/README.md#log) - Log Event



### [Feedback](docs/sdks/feedback/README.md)



* [submit](docs/sdks/feedback/README.md#submit) - Log Feedback

* [list](docs/sdks/feedback/README.md#list) - Get All Feedback

* [getFeedbackById](docs/sdks/feedback/README.md#getfeedbackbyid) - Get Feedback by ID

* [deleteFeedbackById](docs/sdks/feedback/README.md#deletefeedbackbyid) - Delete Feedback by ID



### [Query](docs/sdks/query/README.md)



* [conversations](docs/sdks/query/README.md#conversations) - Query Conversations

* [queryEvents](docs/sdks/query/README.md#queryevents) - Query Events

* [queryFeedback](docs/sdks/query/README.md#queryfeedback) - Query Feedback

* [querySemanticThreads](docs/sdks/query/README.md#querysemanticthreads) - Query Semantic Threads

* [exportSemanticThreadsQueryResults](docs/sdks/query/README.md#exportsemanticthreadsqueryresults) - Export Semantic Threads Query Results

* [exportConversationsQueryResults](docs/sdks/query/README.md#exportconversationsqueryresults) - Export Conversations Query Results

* [exportEventsQueryResults](docs/sdks/query/README.md#exporteventsqueryresults) - Export Events Query Results

* [exportFeedbackQueryResults](docs/sdks/query/README.md#exportfeedbackqueryresults) - Export Feedback Query Results

* [queryPropertyKeys](docs/sdks/query/README.md#querypropertykeys) - Query Property Keys

* [queryPropertyValues](docs/sdks/query/README.md#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](./FUNCTIONS.md).



Available standalone functions



- [`conversationGetConversationByExternalId`](docs/sdks/conversation/README.md#getconversationbyexternalid) - Get Conversation by External ID

- [`conversationsDelete`](docs/sdks/conversations/README.md#delete) - Delete Conversation

- [`conversationsGet`](docs/sdks/conversations/README.md#get) - Get Conversation

- [`conversationsList`](docs/sdks/conversations/README.md#list) - Get All Conversations

- [`conversationsLog`](docs/sdks/conversations/README.md#log) - Log Conversation

- [`eventsLog`](docs/sdks/events/README.md#log) - Log Event

- [`feedbackDeleteFeedbackById`](docs/sdks/feedback/README.md#deletefeedbackbyid) - Delete Feedback by ID

- [`feedbackGetFeedbackById`](docs/sdks/feedback/README.md#getfeedbackbyid) - Get Feedback by ID

- [`feedbackList`](docs/sdks/feedback/README.md#list) - Get All Feedback

- [`feedbackSubmit`](docs/sdks/feedback/README.md#submit) - Log Feedback

- [`queryConversations`](docs/sdks/query/README.md#conversations) - Query Conversations

- [`queryExportConversationsQueryResults`](docs/sdks/query/README.md#exportconversationsqueryresults) - Export Conversations Query Results

- [`queryExportEventsQueryResults`](docs/sdks/query/README.md#exporteventsqueryresults) - Export Events Query Results

- [`queryExportFeedbackQueryResults`](docs/sdks/query/README.md#exportfeedbackqueryresults) - Export Feedback Query Results

- [`queryExportSemanticThreadsQueryResults`](docs/sdks/query/README.md#exportsemanticthreadsqueryresults) - Export Semantic Threads Query Results

- [`queryQueryEvents`](docs/sdks/query/README.md#queryevents) - Query Events

- [`queryQueryFeedback`](docs/sdks/query/README.md#queryfeedback) - Query Feedback

- [`queryQueryPropertyKeys`](docs/sdks/query/README.md#querypropertykeys) - Query Property Keys

- [`queryQueryPropertyValues`](docs/sdks/query/README.md#querypropertyvalues) - Query Property Values

- [`queryQuerySemanticThreads`](docs/sdks/query/README.md#querysemanticthreads) - Query Semantic Threads

- [`topSearchQueries`](docs/sdks/inkeepanalytics/README.md#topsearchqueries) - Top Search Queries

- [`weeklySearchUsers`](docs/sdks/inkeepanalytics/README.md#weeklysearchusers) - Weekly Search Users



## React hooks with TanStack Query



React hooks built on [TanStack Query][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.



[tanstack-query]: https://tanstack.com/query/v5/docs/framework/react/overview



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

[REACT_QUERY.md](./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`](docs/sdks/conversation/README.md#getconversationbyexternalid) - Get Conversation by External ID

- [`useConversationsDeleteMutation`](docs/sdks/conversations/README.md#delete) - Delete Conversation

- [`useConversationsGet`](docs/sdks/conversations/README.md#get) - Get Conversation

- [`useConversationsList`](docs/sdks/conversations/README.md#list) - Get All Conversations

- [`useConversationsLogMutation`](docs/sdks/conversations/README.md#log) - Log Conversation

- [`useEventsLogMutation`](docs/sdks/events/README.md#log) - Log Event

- [`useFeedbackDeleteFeedbackByIdMutation`](docs/sdks/feedback/README.md#deletefeedbackbyid) - Delete Feedback by ID

- [`useFeedbackGetFeedbackById`](docs/sdks/feedback/README.md#getfeedbackbyid) - Get Feedback by ID

- [`useFeedbackList`](docs/sdks/feedback/README.md#list) - Get All Feedback

- [`useFeedbackSubmitMutation`](docs/sdks/feedback/README.md#submit) - Log Feedback

- [`useQueryConversationsMutation`](docs/sdks/query/README.md#conversations) - Query Conversations

- [`useQueryExportConversationsQueryResultsMutation`](docs/sdks/query/README.md#exportconversationsqueryresults) - Export Conversations Query Results

- [`useQueryExportEventsQueryResultsMutation`](docs/sdks/query/README.md#exporteventsqueryresults) - Export Events Query Results

- [`useQueryExportFeedbackQueryResultsMutation`](docs/sdks/query/README.md#exportfeedbackqueryresults) - Export Feedback Query Results

- [`useQueryExportSemanticThreadsQueryResultsMutation`](docs/sdks/query/README.md#exportsemanticthreadsqueryresults) - Export Semantic Threads Query Results

- [`useQueryQueryEventsMutation`](docs/sdks/query/README.md#queryevents) - Query Events

- [`useQueryQueryFeedbackMutation`](docs/sdks/query/README.md#queryfeedback) - Query Feedback

- [`useQueryQueryPropertyKeysMutation`](docs/sdks/query/README.md#querypropertykeys) - Query Property Keys

- [`useQueryQueryPropertyValuesMutation`](docs/sdks/query/README.md#querypropertyvalues) - Query Property Values

- [`useQueryQuerySemanticThreadsMutation`](docs/sdks/query/README.md#querysemanticthreads) - Query Semantic Threads

- [`useTopSearchQueries`](docs/sdks/inkeepanalytics/README.md#topsearchqueries) - Top Search Queries

- [`useWeeklySearchUsers`](docs/sdks/inkeepanalytics/README.md#weeklysearchusers) - 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:

```typescript

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:

```typescript

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



[`InkeepAnalyticsError`](./src/models/errors/inkeepanalyticserror.ts) is the base class for all HTTP error responses. It has the following properties:



| Property            | Type       | Description                                                                             |

| ------------------- | ---------- | --------------------------------------------------------------------------------------- |

| `error.message`     | `string`   | Error message                                                                           |

| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |

| `error.headers`     | `Headers`  | HTTP response headers                                                                   |

| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |

| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |

| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |



### Example

```typescript

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) {

    // The base class for HTTP error responses

    if (error instanceof errors.InkeepAnalyticsError) {

      console.log(error.message);

      console.log(error.statusCode);

      console.log(error.body);

      console.log(error.headers);



      // Depending on the method different errors may be thrown

      if (error instanceof errors.BadRequest) {

        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

      }

    }

  }

}



run();



```



### Error Classes

**Primary errors:**

* [`InkeepAnalyticsError`](./src/models/errors/inkeepanalyticserror.ts): The base class for HTTP error responses.

  * [`BadRequest`](./src/models/errors/badrequest.ts): Bad Request. Status code `400`.

  * [`Unauthorized`](./src/models/errors/unauthorized.ts): Unauthorized. Status code `401`.

  * [`Forbidden`](./src/models/errors/forbidden.ts): Forbidden. Status code `403`.

  * [`UnprocessableEntity`](./src/models/errors/unprocessableentity.ts): Unprocessable Entity. Status code `422`.

  * [`InternalServerError`](./src/models/errors/internalservererror.ts): Internal Server Error. Status code `500`.



Less common errors (7)







**Network errors:**

* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.

* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.

* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.

* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.

* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.



**Inherit from [`InkeepAnalyticsError`](./src/models/errors/inkeepanalyticserror.ts)**:

* [`NotFound`](./src/models/errors/notfound.ts): Not Found. Status code `404`. Applicable to 7 of 22 methods.*

* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.



\* Check [the method documentation](#available-resources-and-operations) 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:

```typescript

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](https://developer.mozilla.org/en-US/docs/Web/API/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:



```typescript

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: 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.



```typescript

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. 



### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=inkeep-analytics-typescript&utm_campaign=typescript)