How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Typesense Analytics Rules API

Create and manage analytics rules that control how search queries and user events are aggregated for query suggestions and relevance tuning.

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

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

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 30.1.

Requests are made against a single base URL, {protocol}://{hostname}:{port}.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
30.1
Base URL
http://localhost:8108
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • api_key_header — API key for authenticating requests to the Typesense server.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Analytics Rules 5

Create and manage analytics rules that control how search queries and user events are aggregated for query suggestions and relevance tuning.

GET
/analytics/rules
List All Analytics Rules
listAnalyticsRules → 200401
POST
/analytics/rules
Create An Analytics Rule
createAnalyticsRule body → 201400401
GET
/analytics/rules/{ruleName}
Retrieve An Analytics Rule
getAnalyticsRule 1 param → 200401404
PUT
/analytics/rules/{ruleName}
Create Or Update An Analytics Rule
upsertAnalyticsRule 1 param body → 200400401
DELETE
/analytics/rules/{ruleName}
Delete An Analytics Rule
deleteAnalyticsRule 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are AnalyticsRule (4 properties), AnalyticsRuleCreateSchema (3 properties). Each schema is shown below with its type and property counts.

AnalyticsRuleCreateSchema
object
3 properties 3 required
AnalyticsRule
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

typesense-analytics-rules-api-openapi.yml Raw ↑

Other APIs Typesense publishes across the network.

Typesense Analytics Events API
Typesense Analytics Operations API
Typesense Cluster Management API
Typesense Configuration Changes API
Typesense Server Configuration Parameters API
Where this information came from

This is an independent, third-party profile of Typesense Analytics Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.